This week's book giveaway is in the OO, Patterns, UML and Refactoring forum.
We're giving away four copies of Five Lines of Code and have Christian Clausen on-line!
See this thread for details.
Win a copy of Five Lines of Code this week in the OO, Patterns, UML and Refactoring forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Bear Bibeault
  • Ron McLeod
  • Jeanne Boyarsky
  • Paul Clapham
Sheriffs:
  • Tim Cooke
  • Liutauras Vilda
  • Junilu Lacar
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Tim Holloway
  • fred rosenberger
  • salvin francis
Bartenders:
  • Piet Souris
  • Frits Walraven
  • Carey Brown

Use of inheritDoc

 
Sheriff
Posts: 11604
178
Hibernate jQuery Eclipse IDE Spring MySQL Database AngularJS Tomcat Server Chrome Java
  • 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
 
Don't get me started about those stupid light bulbs.
    Bookmark Topic Watch Topic
  • New Topic