Special Comments Java provides a special form of comment for generating automatic documentation, and web pages. It uses a tool called javadoc. Within these special comment blocks several special variables, indicated by a leading @, are recognized. Documentation comments: /** * This interface is sure to make any Java object Cool. It * defines no methods, but it adds a certain amount of positive * karma to any class (not to mention that it yields an edible * combination of mathematical constants). * * @see java.hot * @author Leonard McMillan * @version 1.0 */ public abstract interface Cool { public final static int KARMA = Math.PI + Math.E; }
	Lecture 2		Slide 7		6.837 Fall '98

Java also provides a special form of comment that is for generating automatic documentation, and web pages, for Java programs using a tool called javadoc. Within these comment blocks several special variables, indicated by a leading @, are recognized.

Documentation comments:

	/**
	 *  This interface is sure to make any Java object Cool. It
	 *  defines no methods, but it adds a certain amount of positive
	 *  karma to any class (not to mention that it yields an edible
	 *  combination of mathematical constants).
	 *
	 *  @see java.hot
	 *  @author Leonard McMillan
	 *  @version 1.0
	 */
    public abstract interface Cool {
	    public final static int KARMA = Math.PI + Math.E;
	}