Win a copy of The Business Blockchain this week in the Cloud forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

javadoc

 
Fred Barnes
Ranch Hand
Posts: 62
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Guys,
Do I only javadoc public methods and fields?
Or do I javadoc all protected, private and default memebers? Is it nessesary to javadoc all variables, for e.g. JPanel in the GUI?
Regards
Fred
 
Bernhard Woditschka
Ranch Hand
Posts: 89
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I documented public and protected methods.
As that's the potential user of my API will see.
Bern
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic