Documenting Comments in java source file : javadoc tool

The Javadoc tool parses the documentation comments in a set of Java source files and produces a corresponding set of HTML pages describing the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields.

You can run the java doc tool on packages and on individual source files

will see the javadoc tool on a simple program first, will see javadoc on packages in packages section.

Example:

public class CommentsEx{
 /**
 * Program Execution starts from here
 */
 public static void main(String args[]){
  int marks;
  marks = 70;
  System.out.println(marks);
 }
}

when you call javadoc CommentsEx, then javadoc generates the documentation for the file

See the below figure

javadoc produce the documentation in html like below

                           

Comments in Java                                                 Javadoc tags                                                 Home