Javadocs

Basics of Javadocs

Javadocs is essentially a built-in Doxygen-like feature wherein documentation can be automatically generated for a Java code base. The documentation is generated in the same style and format as the Java API documentation.

Javadoc comments look much like Doxygen comments: they are denoted with /** Special Comment Blocks */ and use various tags to specify useful information.

Here is an example:

/** Hello World Class.
 * This class says hello to the world.
 */
public class HelloWorld {
    public static void main(String[] args) { 
        sayHello();
    }

    /** Subroutine to print hello world to the screen */
    public static void sayHello() {
        System.out.println("Hello world!");
    }
}

Flags

See also:

• Template:DataStructuresFlag
• Template:AlgorithmsFlag