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

Use of inheritDoc

 
Roel De Nijs
Sheriff
Posts: 10400
133
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all,

Does someone use the javadoc @inheritDoc in his/her project ?

For more information: inheritDoc

i find it especially useful if you implement some interface (normally you would have the @see interface.method), but if you later change that method and add some extra parameter you have to change all those @see for all implementation you made.
if you use @inheritDoc you don't have the problem, BUT you loose (i guess) the notification that this method is implementation of interface-method because it just copies the javadoc-comment from interface's method and place it with the implementation-method

so don't think that's a good idea and will make things not so clear as with the @see tag
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic