Java 產生JavaDoc文件

Java產生JavaDoc文件的方式如下。

例如專案根目錄有一支Java程式如下：

HelloWorld.java

/**
 * HelloWorld Application
 * 
 * @author matthung0807
 * @since 20260711
 */
public class HelloWorld {

    /**
     * Hello World main entry point
     * @param args
     */
    public static void main(String[] args) {
        System.out.println("Helll World");
    }
    
}

在專案根目錄開啟命令列，輸入javadoc -d doc/ *.java，則會根據目前目錄中所有的.java程式中的JavaDoc comment來產生JavaDoc文件在同目錄下的doc中。-d代表要JavaDoc的放置目錄。

~/../java-demo% javadoc -d doc/ *.java 
Loading source file HelloWorld.java...
Constructing Javadoc information...
Creating destination directory: "doc/"
Building index for all the packages and classes...
Standard Doclet version 21.0.2
Building tree for all the packages and classes...
Generating doc/HelloWorld.html...
HelloWorld.java:11: warning: no description for @param
     * @param args
       ^
HelloWorld.java:7: warning: use of default constructor, which does not provide a comment
public class HelloWorld {
       ^
Generating doc/package-summary.html...
Generating doc/package-tree.html...
Generating doc/overview-tree.html...
Building index for all classes...
Generating doc/allclasses-index.html...
Generating doc/allpackages-index.html...
Generating doc/index-all.html...
Generating doc/search.html...
Generating doc/index.html...
Generating doc/help-doc.html...
2 warnings

前往doc目錄，瀏覽器開啟index.html即可瀏覽JavaDoc文件。

• JavaDoc Tool