Echoing earlier sentiments that there's no explicit Right Way To Do Comments(tm), but here's my 2 cents:
- I much prefer test cases to Javadoc. Call it 'executable' documentation if it makes you feel better :) - comments serve different purposes for "whitebox" and "blackbox" code. For example, my colleagues, who already have access to the source, rarely need method level comments, since they can see the source (and crucially, the tests). However, when it comes to using a library, I may not have access to the source, or the time to understand the author's conventions/style/metaphors, etc. In that case, I want to see Javadocs, preferably with examples. I try to picture Guava without any Javadocs, and it suddenly becomes much harder to use. - I have came across more harmful/useless comments than useful ones. If there was an Eclipse shortcut for "remove all comments", I'd probably use it a lot. Regards, Graham -- You received this message because you are subscribed to the Google Groups "Java Posse" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/javaposse?hl=en.
