• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

documentation of methods

 
Gosling Gong
Ranch Hand
Posts: 51
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
Mark
 
Sai Prasad
Ranch Hand
Posts: 560
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Greenhorn
Posts: 10
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Regards
Arup
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic