This week's book giveaway is in the Big Data forum.
We're giving away four copies of Elasticsearch in Action and have Radu Gheorghe & Matthew Lee Hinman on-line!
See this thread for details.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes [URLyBird] Javadoc comments Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Elasticsearch in Action this week in the Big Data forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "[URLyBird] Javadoc comments" Watch "[URLyBird] Javadoc comments" New topic
Author

[URLyBird] Javadoc comments

Leszek Zajac
Greenhorn

Joined: May 18, 2006
Posts: 19
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


Leszek
Jeroen T Wenting
Ranch Hand

Joined: Apr 21, 2006
Posts: 1847
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.


42
 
Consider Paul's rocket mass heater.
 
subject: [URLyBird] Javadoc comments