Java Documentation

Last modified Thursday, 24-Aug-2000 09:19:56 EST.

Overview
- Specifies a standard for documenting Java programs
- javadoc comments must precede the class, field, constructor or method declaration being documented.
- General format of a javadoc comment:
```
/**
   One sentence, ending with a ., describing the purpose.
   @Tag Description
   ...
*/
          
```
- javadoc comments can contain HTML markup.
- Example: DocStudent.java, DocStudent.html
- Include tags in the following order:
  - @author - classes and interfaces only, required
  - @version - classes and interfaces only, required.
  - @param - methods and constructors only
  - @return - methods only
  - @exception - @throws is a synonym added in Javadoc 1.2
  - @see
  - @since
  - @serial - or @serialField or @serialData
  - @deprecated - see How and When To Deprecate APIs
In IntelliJ
To add JavaDoc stubs in the editor, start the JavaDoc /** and press enter.
To render JavaDocs in the editor, click the "lines" icon in the gutter next to the /** starting the JavaDoc comment.
To create WWW pages
- Create a directory called docs in the project.
- In the "Tools" menu, select "Generate JavaDoc ..."
- Set the "Output directory" to the docs directory
- "Generate"!
Read more here.

Class Documentation

/**
Class description.
@author Name of class author 
@version Version information
@see Classname
*/

Constructor and Method Documentation

/**
Method description.
@param One-for-each-parameter-name Parameter-description
@return Return value description
@exception Fully qualified exception classname Description
@see Classname
*/

Attribute Documentation

/**
Attribute description.
@see Classname
*/

Example

javadoc options

-private includes generation for private features.
-version includes generation of version information
Read more at the javadoc WWW site.

Java Documentation

Tutorial Tasks

Exercises

Sample Exam Questions