![Java项目驱动开发教程](https://wfqqreader-1252317822.image.myqcloud.com/cover/266/52843266/b_52843266.jpg)
上QQ阅读APP看书,第一时间看更新
1.8 javadoc命令
javadoc命令用于将标准的javadoc注释生成文档。javadoc标准注释一般是:注释到类上,对类起说明作用;注释到方法或成员变量上,对方法或者功能成员变量的含义做出说明。例如,存在以下javadoc注释。
【文件1.4】 ExampleJavaDoc.java
![](https://epubservercos.yuewen.com/E43DD5/31398662104176806/epubprivate/OEBPS/Images/Figure-P24_34287.jpg?sign=1739048309-9fQPT97hzYaaHNU9tZFWQ6sX2OPzqpor-0-94f4a9312710d47e0a1b7e32951f5ba3)
使用以下命令生成标准文档:
D:\java>javadoc -author ExampleJavaDoc.java 正在加载源文件ExampleJavaDoc.java... 正在构造Javadoc信息... 标准Doclet版本 1.8.0_77 正在构建所有程序包和类的树... 正在生成.\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所示。
![](https://epubservercos.yuewen.com/E43DD5/31398662104176806/epubprivate/OEBPS/Images/Figure-P25_1886.jpg?sign=1739048309-nGSlPu2Bn8QF00BHyeaj2yHFV729hwbr-0-10719d91260a61ba6a454e27242b45f2)
图1-13
![](https://epubservercos.yuewen.com/E43DD5/31398662104176806/epubprivate/OEBPS/Images/Figure-P25_1887.jpg?sign=1739048309-J2OVB5EJufTY2ZcLiCL2vkagG8xlEEWQ-0-d105a15a347d6dc573d50421f08dccf1)
图1-14