Win a copy of Functional Reactive Programming this week in the Other Languages forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

I want to ask 2 questions about javadoc.

 
Yanxin Zhao
Ranch Hand
Posts: 65
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
Yanxin Zhao
Ranch Hand
Posts: 65
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
"comments copied from Interface" The Javadocs will not display that.

Mark
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic