Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

should we JavaDoc private variables?

 
Kathy Shkarlet
Ranch Hand
Posts: 43
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
My standard coding practice is to JavaDoc everything, but the classes provided as a part of my assignment did not JavaDoc private members! So I found myself guessing whether I should add JavaDoc on their classes or remove it from my private vars or risk be inconsistent... I'm curious what other people did and if any document rules it.
I'm also very curious if there is a standard level to use when preparing html JavaDoc - i.e should we include public only or public/protected or ...
Thanks
 
Jerry Pulley
Ranch Hand
Posts: 221
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Kathy,
Even if put doc comments on private and package members, you have to use a switch on the command line when you invoke Javadoc if you want it to build HTML for them. I guess if there is an implied "standard level", it's to Javadoc only public and protected members.
Jerry
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic