Login | Register   
LinkedIn
Google+
Twitter
RSS Feed
Download our iPhone app
TODAY'S HEADLINES  |   ARTICLE ARCHIVE  |   FORUMS  |   TIP BANK
Browse DevX
Sign up for e-mail newsletters from DevX


Tip of the Day
Language: Java
Expertise: Intermediate
Nov 12, 1999

What Is Javadoc?

Javadoc is a program shipped with JDK that you can use to run over your source code to produce documentation of your classes in the same type of HTML files that Sun Microsystems has used for its Java API documentation. To use javadoc on your source code, you have to tag your code with a certain type of comment formats. A simple example of Javadoc comments looks like this:
 
/** 
* Class MyButton implements java.io.Serailizable,
extends java.awt.Button */ public class MyButton { /** * Does nothing interesting * * @param image the image to show on button * @param label text to show on button */ public MyButton(String label, Image image) { //code here } //rest of class here }
Javadoc comments start with /**, end with */, and, in-between, use tags such as @param, @return, and @exception to describe the workings of a method.
Extracted comments are processed into a set of HTML files for later perusal by a web browser. Using Javadoc, you can view the class hierarchy, an index of all methods and fields, and the details of each class.
The nice thing about Javadoc comments is that you can embed HTML tags to format your text. For example:
 
/** 
* <B>The Use Of This Class is Prohibited By Law.</B> 
*/ 
will make "The Use Of This Class is Prohibited By Law." appear in bold.

For a definitive guide on javadoc conventions, look up Chapter 18 of the book "The Java Language Specification" at: http://java.sun.com/docs/books/jls/html/index.html .

If you job involves heavy documentation of Java code, look up a tool called MIMDoc at: http://www.mimsoftware.com/mimdoc.htm.
MIMDoc, a 100% java tool, is a javadoc-compatible documentation generator with many additional features, among them:

1. Full-featured category management to let you group objects by categories.
2. More HTML format options.
3. Conditional generation of object documentation, which helps you distinguish between several documentation levels or versions.
4. @code sub tag allows inclusion of sample code in you documentation.

Behrouz Fallahi
 
Comment and Contribute

 

 

 

 

 


(Maximum characters: 1200). You have 1200 characters left.

 

 

Sitemap