aspose file tools*
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 EJB 3 in Action this week in the EJB and other Java EE Technologies forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Documentation Comments (scjd)" Watch "Documentation Comments (scjd)" New topic
Author

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?
Thanks.


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

Joined: Feb 05, 2001
Posts: 17249
    
    6

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


Perfect World Programming, LLC - Two Laptop Bag - Tube Organizer
How to Ask Questions the Smart Way FAQ
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Documentation Comments (scjd)
 
Similar Threads
Javadoc documentation??
NX: Should I reformat the provided interfaces comments?
B&S: What types do you comment with javadoc?
javadoc comments for interfaces AND implementing classes?
Disallowed to use private inner classes?