Originally posted by Thomas Kijftenbelt:
Hi,
A question regarding the javadoc comments: when you implement a method from an interface, do you refer to the javadoc comment of the interface, or do you write a full comment, e.g.
or
I personally would prefer the first option, but is this in line with the SCJD requirements.
Greetings,
TK
[ May 12, 2003: Message edited by: Thomas Kijftenbelt ]
I cant seem to find Sun's
doc regarding this, I didn't bookmark it, but this comment from DocCheck's warning supports what I read previously, which is that comments are not required, the standard is to add a comment of this form //Inherited from suncertify.db.DBMain, heres a snippet from DocCheck
Warning Generated for methods without comments that override a superclass method or implement an interface. Such methods need no comments, because it will be inherited. A warning is generated though, so the developer can check to see that a normal comment of the form // Inherited {<from>} is included in the code. Can also be the level assigned to "self-evident" comments using the -evident switch. May be used in the future.
PS Andrew, I cant get DocCheck to run I'll post errors later, do you have it running with 1.4.*?
I think it may have a problem with {@value CONSTANT} tags