This week's book giveaway is in the Big Data forum.
We're giving away four copies of Elasticsearch in Action and have Radu Gheorghe & Matthew Lee Hinman on-line!
See this thread for details.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Use of inheritDoc Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Elasticsearch in Action this week in the Big Data forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Use of inheritDoc" Watch "Use of inheritDoc" New topic
Author

Use of inheritDoc

Roel De Nijs
Bartender

Joined: Jul 19, 2004
Posts: 6070
    
  20

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


SCJA, SCJP (1.4 | 5.0 | 6.0), SCJD
OCAJP 7
 
It is sorta covered in the JavaRanch Style Guide.
 
subject: Use of inheritDoc