可以使用javadoc工具生成Java文档.它目前以html 4.0格式生成文档.在java 9中,我们可以在命令行参数中使用-html5选项生成html 5格式的文档.
旧式java文档
考虑以下代码在C:/JAVA文件夹中.
Tester.java
/** * @author MahKumar * @version 0.1*/public class Tester { /** * Default method to be run to print *Hello world
* @param args command line arguments */ public static void main(String []args) { System.out.println("Hello World"); }}
现在运行jdk 7的javadoc工具生成文档.
C:\JAVA>javadoc -d C:/JAVA Tester.javaLoading source file tester.java...Constructing Javadoc information...Standard Doclet version 1.7.0_21Building tree for all the packages and classes...Generating C:\JAVA\Tester.html...Generating C:\JAVA\package-frame.html...Generating C:\JAVA\package-summary.html...Generating C:\JAVA\package-tree.html...Generating C:\JAVA\constant-values.html...Building index for all the packages and classes...Generating C:\JAVA\overview-tree.html...Generating C:\JAVA\index-all.html...Generating C:\JAVA\deprecated-list.html...Building index for all classes...Generating C:\JAVA\allclasses-frame.html...Generating C:\JAVA\allclasses-noframe.html...Generating C:\JAVA\index.html...Generating C:\JAVA\help-doc.html...
它将在C:/JAVA目录中创建java文档页面,您将看到以下输出.
支持搜索和HTML5的新java文档
运行jdk的javadoc工具9使用-html5标志生成新类型的文档.
C:\JAVA> javadoc -d C:/JAVA -html5 Tester.javaLoading source file Tester.java...Constructing Javadoc information...Standard Doclet version 9.0.1Building tree for all the packages and classes...Generating C:\JAVA\Tester.html...Generating C:\JAVA\package-frame.html...Generating C:\JAVA\package-summary.html...Generating C:\JAVA\package-tree.html...Generating C:\JAVA\constant-values.html...Building index for all the packages and classes...Generating C:\JAVA\overview-tree.html...Generating C:\JAVA\index-all.html...Generating C:\JAVA\deprecated-list.html...Building index for all classes...Generating C:\JAVA\allclasses-frame.html...Generating C:\JAVA\allclasses-frame.html...Generating C:\JAVA\allclasses-noframe.html...Generating C:\JAVA\allclasses-noframe.html...Generating C:\JAVA\index.html...Generating C:\JAVA\help-doc.html...
<它将在D:/test目录中创建更新的java文档页面,您将看到以下输出.