Java is not a language with training wheels. It is a language for professional programmers.

— Hebert Sheildt

Generating Javadocs

Java supports three types of comments:
a. Single Line
//
b. Multiline
/* */
c. Documentation Comments
/**
*
*/

The third type of comment allowed is for providing information about the class. The comments that come under these comments are useful while generating Javadocs. Javadocs are a reference for the programmer while using the class. We often use Javadocs to know about the functionalities provided by the class.

It can be generated by a tool “javadoc.exe” provided by the JDK itself.

Annotations, a form of metadata, provide data about a program that is not part of the program itself. Annotations have no direct effect on the operation of the code they annotate.

The annotations that can be used while generating Javadocs are:
@author
@param
@return
@version

@author and @version are not included in Javadocs, we need to set –author and –version flag while generating the Javadocs.



© Copyright © 2013 SourabhBawage.com. All Rights Reserved.