my dog learned polymorphism*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes javadoc comments for interfaces AND implementing classes? Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Android Security Essentials Live Lessons this week in the Android forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "javadoc comments for interfaces AND implementing classes?" Watch "javadoc comments for interfaces AND implementing classes?" New topic
Author

javadoc comments for interfaces AND implementing classes?

Leonardo Penha
Ranch Hand

Joined: Feb 15, 2002
Posts: 68
Quoted from instructions.html:
"...and javadoc style comments must be used for each element of the public interface of each class."
In case there is a class that implements an interface, and we only write javadoc comments in the interface - but not the class - then the description of the methods in the interface are copied from the interface documentation to the class' documentation.
Is it ok to write javadoc comments only for the interface methods, or do we have to write javadoc comments for the class' methods as well?


Leonardo Penha<br />SCJP, SCJD, SCWCD, SCEA, SCMAD, SCDJWS
Michael Morris
Ranch Hand

Joined: Jan 30, 2002
Posts: 3451
Hi Leonardo,
That depends on the implementing class. If there is something unusual or different, then you should probably javadoc it again in the implementation, otherwise just let the interface's javadoc be used.
Hope this helps,
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
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: javadoc comments for interfaces AND implementing classes?
 
Similar Threads
Disallowed to use private inner classes?
javadoc for implementing public methods
Javadoc documentation??
Java Docs
javadoc for SUN interface