File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes documentation of methods Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "documentation of methods" Watch "documentation of methods" New topic

documentation of methods

Gosling Gong
Ranch Hand

Joined: Jun 20, 2002
Posts: 51
The data Sun provided already has documentations/comments on every methods, I am wondering what should we document the methods that declared in DataInterface.
Most of guys here should have at least three class/interface declare the same methods with the Data Class, should we document them same? or just write something different there?
Mark Spritzler

Joined: Feb 05, 2001
Posts: 17276

Actually for classes implementing an interface, you won't need to provide Javadoc for the implementing class, it will use the ones you put into the interface. Or is it the other way around? I am pretty sure it is the correct way.

Perfect World Programming, LLC - iOS Apps
How to Ask Questions the Smart Way FAQ
Sai Prasad
Ranch Hand

Joined: Feb 25, 2002
Posts: 560
For some reason I couldn't get the javadoc to derive the comments for the class methods defined and commented in the interface. I copied the comments in 3 different places.
Arup Chowdhury

Joined: Jan 20, 2002
Posts: 10
Try using some Tool which performs Javadoc tests ie it tests whether You have implemented Javadoc comments correctly or not. It is helpful in case we miss out somewhere.
Forte is one such tool
I agree. Here's the link:
subject: documentation of methods
It's not a secret anymore!