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

javadoc quesion - private methods/classes ?

 
Suchak Jani
Ranch Hand
Posts: 70
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Team,
Maybe, those who passed can answer this.
Does the javadoc have to document the private methods and classes.
The only reason i ask is that i have lot of useful/important code there.
Regards
Suchak Jani
 
Peter den Haan
author
Ranch Hand
Posts: 3252
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I did javadoc all methods without exception, but generated the javadoc only for public and protected methods. Especially the server javadoc would primarily be a resource for other developers writing database clients; from their point of view, private methods would just clutter up their documentation.
Take a closer look at the JDK javadoc.
- Peter
 
Suchak Jani
Ranch Hand
Posts: 70
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks peter
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic