Win a copy of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) this week in the OCAJP forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

letting javadoc copy comments from interface

 
Pete Lyons
Ranch Hand
Posts: 109
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I've documented all of the methods on my to the database, and I'm very tempted to just have a class comment on the local implementation that describes that it just directly accesses it's Data instance variable, and then not add any javadoc to the methods since javadoc will copy them from the interface. This feature was added to javadoc for occasions just like this, but I'm nervous about whether the assessor will consider this appropriate or not. Any thoughts? Thanks.
 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Pete,
I did that unless the method's implementation was notably different in the implementing class. But I lost a point on documentation and have know idea where or why, so who knows?
Michael Morris
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic