Win a copy of Re-engineering Legacy Software this week in the Refactoring forum
or Docker in Action in the Cloud/Virtualization forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

JavaDoc for interface implementation methods?

 
Roy Mallard
Ranch Hand
Posts: 53
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If I have JavaDoc for my interface methods, do I also have to do JavaDoc for the implementations of those methods?
 
Jeroen T Wenting
Ranch Hand
Posts: 1847
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I've just used the @inheritDoc javadoc tag for the implementations to avoid duplication.
 
Simon Cockayne
Ranch Hand
Posts: 214
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Roy,

Have you looked at this:

http://java.sun.com/j2se/javadoc/writingdoccomments/

Cheers,

Simon
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic