This week's giveaway is in the Spring forum.
We're giving away four copies of REST with Spring (video course) and have Eugen Paraschiv on-line!
See this thread for details.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Documentation Comments (scjd) Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of REST with Spring (video course) this week in the Spring forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Documentation Comments (scjd)" Watch "Documentation Comments (scjd)" New topic

Documentation Comments (scjd)

Zakaria Haque
Ranch Hand

Joined: Jan 02, 2002
Posts: 60
Hi guys, I am little confused about how much javadoc style comment should we use. I have the following statements in my instructions
1. "javadoc style comments must be used for each element of the public interface of each class"
2. "You must provide HTML/Javadoc documentation for all classes, whether supplied, modified, or new"

Does that mean we can spare the non-public api from javadoc commenting?

tobe bondhu nouka bherao<br />shonabo gaan aj shara raat
Mark Spritzler

Joined: Feb 05, 2001
Posts: 17276

I would javadoc all your methods, even the private ones.

Perfect World Programming, LLC - iOS Apps
How to Ask Questions the Smart Way FAQ
I agree. Here's the link:
subject: Documentation Comments (scjd)
It's not a secret anymore!