Mention “commenting” to a developer and they will wince, either because they are working on some code that is poorly commented, or because they have ignored commenting in their own work. It doesn't have to be that way.
In this chapter:
[comment.when] When to comment the code
[comment.not] When NOT to comment
[comment.deprecated] @deprecated but always say why
[comment.language] Watch the language in comments
[comment.useful] Comments should enlighten the reader
[comment.update] Update or remove obsolete comments
[comment.jsp] Use correct JSP comments
[comment.when] When to comment the code
[comment.not] When NOT to comment
[comment.deprecated] @deprecated but always say why
[comment.language] Watch the language in comments
[comment.useful] Comments should enlighten the reader
[comment.update] Update or remove obsolete comments
[comment.jsp] Use correct JSP comments