深入浅出Java编程
上QQ阅读APP看书,第一时间看更新

1.10 javadoc命令

javadoc命令用于将标准的javadoc注释生成文档。javadoc标准注释一般是:注释到类上,对类起说明作用;注释到方法或是成员变量上,对方法或者功能成员变量含义做出说明。例如,存在以下javadoc注释:

【文件1.4】ExampleJavaDoc.java

使用以下命令生成标准文档:

D:\java>javadoc -author ExampleJavaDoc.java
正在加载源文件ExampleJavaDoc.java...
正在构造Javadoc信息...
标准Doclet版本 1.8.0_281
正在构建所有程序包和类的树...
正在生成.\cn\oracle\ExampleJavaDoc.html...
正在生成.\cn\oracle\package-frame.html...
正在生成.\cn\oracle\package-summary.html...
正在生成.\cn\oracle\package-tree.html...
正在生成.\constant-values.html...
正在构建所有程序包和类的索引...
正在生成.\overview-tree.html...
正在生成.\index-all.html...
正在生成.\deprecated-list.html...
正在构建所有类的索引...
正在生成.\allclasses-frame.html...
正在生成.\allclasses-noframe.html...
正在生成.\index.html...
正在生成.\help-doc.html...

第1行是生成的命令,后面是自动生成文档时输出的信息。生成以后的文档如图1-13所示。

打开index.html,将会看到标准的javadoc文档,如图1-14所示。

图1-13

图1-14