Java文档可以使用javadoc
工具生成。 它目前以html 4.0
格式生成文档。 在java 9中,可以通过在命令行参数中使用-html5
选项生成html 5
格式的文档。
旧式的java文档
考虑F:\worksp\java9文件夹中有一个Java文件:Tester.java,其代码如下 -
/** * @author 小马哥(Maxsu) * @version 0.1 */ public class Tester { /** * Default method to be run to print * <p>Hello world</p> * @param args command line arguments */ public static void main(String []args) { System.out.println("Hello World"); } }
可以运行jdk 7 的javadoc工具来生成文档。
使用-html5
标志运行jdk 9的javadoc工具以生成新类型的文档。
F:\worksp\java9>javadoc -html5 Tester.java 正在加载源文件Tester.java... 正在构造 Javadoc 信息... 标准 Doclet 版本 9.0.4 正在构建所有程序包和类的树... 正在生成.\Tester.html... 正在生成.\package-frame.html... 正在生成.\package-summary.html... 正在生成.\package-tree.html... 正在生成.\constant-values.html... 正在构建所有程序包和类的索引... 正在生成.\overview-tree.html... 正在生成.\index-all.html... 正在生成.\deprecated-list.html... 正在构建所有类的索引... 正在生成.\allclasses-frame.html... 正在生成.\allclasses-frame.html... 正在生成.\allclasses-noframe.html... 正在生成.\allclasses-noframe.html... 正在生成.\index.html... 正在生成.\help-doc.html...
打开生成的文件,如下所示 -