Will Klem wrote:
Traditional comments are useful to me, or anyone else reading the code, to reveal the intent of various parts of the program. Javadocs appear to be for larger projects, especially those employing a team of programmers. If my understanding is correct, the format of javadocs provides important information to other members of the team to allow them to write their code to be compatible with any other classes or methods which may interact with the code which has generated the javadoc. This provides more clean integration of the code into a fully functional program. This would be true in both development stages and upgrades. It appears that details about classes, methods, parameters, etc. can be provided without necessitating the reading of hundreds (or more) lines of code.
If yes, then use /** comments */
Does the user need to know about interactions between the different classes?