Insert documentation here
Ah I really hate opening code and seeing the following
/**
* Insert class or interface description here.
*/
This is created by the IDE’s helpful “create new class” (and similar) menu options.
I wish 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!