Just a couple of the more extreme JavaDoc standards I came across in a brief search.
Exhibit One: EMBOSS: Code Documentation Standards The parameter codes and argument codes just seem over the top. If the code is so long and convoluted that you can derive that info from a quick inspection then it probably needs refactoring. Also looks like it would rapidly get out of date, are you really going to maintain a coded indicator for each parameter. For APIs I could see that more info might be useful but the Sun APIs don't use all of this stuff so why should you?
Exhibit Two: DJVM Coding Standards - DRAFT Again, I think the danger is that the doc will become out of step with the code, then both are wrong. For instance, are you really going to maintain all this information about each method.
/**
Description
Method Parameters
Return Value
Preconditions
Postconditions
Invariants
Known Bugs
External method calls
Exceptions Thrown
Concurrency Issues
Deprecation
Visiblity Issues
Date Created
Author
*/
Posted by Alex at August 12, 2003 08:27 PM