javadoc文档的生成方法
合集下载
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
javadoc文档的生成方法
在使用javadoc生成文档时,应当遵守一定的格式规范。
大致的步骤如下:
1. 安装好JDK,检查 javac 编译器;
2.给源代码添加注释;
3. 使用 javadoc 命令,指定源文件的路径,加上-d指定文档的输出目录;
4. 如果想生成引用,-link参数需指定到 Java API 的目录;
5. 使用-subpackages参数指定要包括的子包,用-exclude参数排除不需要的子包;
6. 通过执行 javadoc 命令,生成文档;
7. 可以使用-overview参数指定总体文档;
8. 通过window>preferences>Java>javadoc设置更多参数,以达到更好的文档效果;
9. 通过ant文件构建自动打包文档;
10.打开生成的文档进行检查与测试,确保文档满足需求。