File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
Win a copy of Clojure in Action this week in the Clojure forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

[URLyBird] Javadoc comments

 
Leszek Zajac
Greenhorn
Posts: 19
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello.

My specification says:
"... javadoc style comments must be used for each element of the public interface of each class."

So I should have javadoc comments for public methods (and variables if any).
But should I write javadocs for protected methods and variables?

Best regards
 
Jeroen T Wenting
Ranch Hand
Posts: 1847
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I provide Javadoc comments for everything except some datamembers (mostly private ones).
The generated Javadoc I limit to public only to save a bit of space.
 
With a little knowledge, a cast iron skillet is non-stick and lasts a lifetime.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic