Submitted by Anonymous on Wed, 01/06/2010 - 16:46.
In general, I agree that code should be self-documenting.
However, some of these examples could be destined for javadoc.
Admittedly, these examples do not strictly follow javadoc conventions. However, a bit of explanatory candy for the javadoc to munch on is better than nothing, especially if I am not necessarily looking at the code at the moment but some automatically generated documentation.
Reply
daily quotes
Programming is not a zero-sum game. Teaching something to a fellow programmer doesn't take it away from you. I'm happy to share what I can, because I'm in it for the love of programming.
How about comments specifically meant for javadoc?
In general, I agree that code should be self-documenting.
However, some of these examples could be destined for javadoc.
Admittedly, these examples do not strictly follow javadoc conventions. However, a bit of explanatory candy for the javadoc to munch on is better than nothing, especially if I am not necessarily looking at the code at the moment but some automatically generated documentation.