Javadoc is a tool that is used to create html pages based on comments inside Java code. In order for Javadoc to be created properly, Java comments must be in a certain format. Some simple formats are listed below.

Class comment:

                              /**
                              * Class description
                              * 
                              * @author Author Q. Name
                              * /
                              

Instance variable comment:

                              /**
                              * Variable description
                              */
                              

Method with parameter comment:

                              /**
                              * Method description
                              * @param name description
                              * @param name2 description
                              * @return int
                              * @exception exception description
                              */
                              public int method(String name, String name2) throws exception