aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes I want to ask 2 questions about javadoc. 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 "I want to ask 2 questions about javadoc." Watch "I want to ask 2 questions about javadoc." New topic
Author

I want to ask 2 questions about javadoc.

Yanxin Zhao
Ranch Hand

Joined: May 05, 2004
Posts: 65
Hi everyone:
I got 2 questions about javadoc.
1. my instruction said that "javadoc style comments must be used for each element of the public interface of each class", so I want to ask is it need to provide javadoc comments to methods of class which implements Interface or abstract class?
2. is it must to provide javadoc comments for those methods that in ActionListener?
Mark Spritzler
ranger
Sheriff

Joined: Feb 05, 2001
Posts: 17260
    
    6

If you put the Javadoc in the interface or class that gets extended, you do not have to recreate those comments. They will appear in the implemented class also.

Not sure what you really mean in the second question. You normally don't rewrite comments when you use a Java class already in the language. However, if you have an individual method that you do something specific for your application, then you should provide comments.

Mark


Perfect World Programming, LLC - Two Laptop Bag - Tube Organizer
How to Ask Questions the Smart Way FAQ
Yanxin Zhao
Ranch Hand

Joined: May 05, 2004
Posts: 65
Hi Mark:
Thanks for your reply.
I think I should privade javadoc comments for those methods. if you do not provide javadoc comments for those methods , you will see a words that "comments copied from Interface(I forget that, but the mean is the same.)". And the jdk document never have such words, so I thought I should provide javaodc comments for those method.
Mark Spritzler
ranger
Sheriff

Joined: Feb 05, 2001
Posts: 17260
    
    6

"comments copied from Interface" The Javadocs will not display that.

Mark
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: I want to ask 2 questions about javadoc.