aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes letting javadoc copy comments from interface Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Spring in Action this week in the Spring forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "letting javadoc copy comments from interface" Watch "letting javadoc copy comments from interface" New topic
Author

letting javadoc copy comments from interface

Pete Lyons
Ranch Hand

Joined: Aug 18, 2002
Posts: 109
I've documented all of the methods on my to the database, and I'm very tempted to just have a class comment on the local implementation that describes that it just directly accesses it's Data instance variable, and then not add any javadoc to the methods since javadoc will copy them from the interface. This feature was added to javadoc for occasions just like this, but I'm nervous about whether the assessor will consider this appropriate or not. Any thoughts? Thanks.
Michael Morris
Ranch Hand

Joined: Jan 30, 2002
Posts: 3451
Hi Pete,
I did that unless the method's implementation was notably different in the implementing class. But I lost a point on documentation and have know idea where or why, so who knows?
Michael Morris


Any intelligent fool can make things bigger, more complex, and more violent. It takes a touch of genius - and a lot of courage - to move in the opposite direction. - Ernst F. Schumacher
 
It is sorta covered in the JavaRanch Style Guide.
 
subject: letting javadoc copy comments from interface