Useless default documentation dilutes both code and actual documentation

By Adrian Smith7 Aug 2007100 words1 mins to read

IDEs can create default code, including default documentation, such as:

/**
 * Insert class or interface description here.
 */

It would be great if people would actually write documentation. Even a single sentence to describe what the class is modeling would be helpful if it's not obvious from the name. Or object invariants (e.g. boughtCount <= offeredCount).

To find a class without documentation is annoying. But to see such an IDE-generated phrase is a slap in the face!

This article was written by Adrian Smith on 7 Aug 2007

Follow me: Facebook | Twitter | LinkedIn | Email

More on: Project Management | Tools