File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes JavaDoc package and class description 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 "JavaDoc package and class description" Watch "JavaDoc package and class description" New topic

JavaDoc package and class description

K. Tsang

Joined: Sep 13, 2007
Posts: 3061

Hello, I'm finishing up my assignment and want to ask about the javadoc for the package and class level.

How much description is needed for a package and class? Currently I use a one-liner describing the purpose of the package or class. Is it necessary to expand this by say including how this class is used in my application etc?


K. Tsang JavaRanch SCJP5 SCJD OCPJP7 OCPWCD5 OCPBCD5 OCPWSD5 OCMJEA5 part 1 part 2/3
I agree. Here's the link:
subject: JavaDoc package and class description
It's not a secret anymore!