Java automatically generates api documentation (1): javadoc

1.javadoc

javadoc -help

javadoc的用法: javadoc [options] [packagenames] [sourcefiles] [@files]

Simplest usage: javadoc User.java

2. Custom output

One of them is:

 -doclet <class> Generate output by alternative doclet

public class DocUtil {

    private static RootDoc rootDoc = null;

    public static RootDoc getRootDoc(String classPath) {
        String[] docArgs = new String[]{
                "-doclet",
                DocUtil.class.getName(),
                classPath
        };
        com.sun.tools.javadoc.Main.execute(docArgs);
        return rootDoc;
    }

    public static boolean start(RootDoc root) {
        rootDoc = root;
        return true;
    }

    public static void main(String[] args) {
        String classPath = "E:\\workspace\\doc\\src\\main\\java\\src\\User.java";
        RootDoc rootDoc = getRootDoc(classPath);
//        com.sun.tools.javadoc.Main.main(new String[]{"javadoc", "E:\\workspace\\doc\\src\\main\\java\\src\\User.java"});
    }

}

Official documentation: http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html#basics