my dog learned polymorphism
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 Make it so: Java DB Connections & Transactions this week in the JDBC forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "[URLyBird] Javadoc comments" Watch "[URLyBird] Javadoc comments" New topic

[URLyBird] Javadoc comments

Leszek Zajac

Joined: May 18, 2006
Posts: 19

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

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.

I agree. Here's the link:
subject: [URLyBird] Javadoc comments
jQuery in Action, 3rd edition