File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes JavaDoc package and class description Big Moose Saloon
  Search | Java FAQ | Recent Topics
Register / Login


JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Reply Bookmark "JavaDoc package and class description" Watch "JavaDoc package and class description" New topic
Author

JavaDoc package and class description

K. Tsang
Ranch Hand

Joined: Sep 13, 2007
Posts: 1259

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?

Thanks.

K. Tsang JavaRanch SCJP5 SCJD/OCM-JD
 
I agree. Here's the link: http://ej-technologies/jprofiler - if it wasn't for jprofiler, we would need to run our stuff on 16 servers instead of 3.
 
subject: JavaDoc package and class description
 
Similar Threads
Package Description
NX: URLy Bird 1.3.1 JavaDocs
JavaDoc and package index
[ant] javadoc task
Javadoc for Package