版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/hlx20080808/article/details/84561991
JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。
JavaDoc能够从源代码中抽取类、属性、方法等的注释,形成一个配套的API帮助文档
以//: 开始,以///:~结束。
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
生成JavaDoc的步骤是:
Tools|Generate JavaDoc....
弹出对话框
1. 选择是整个项目还是模块还是单个文件 oop2
2. 文档输出路径 Output directory: c:\oop2
3. Locale 选择地区,这个决定了文档的语言,中文就是zh_CN
扫描二维码关注公众号,回复:
4830382 查看本文章
4. 传入JavaDoc的参数,一般这样写
-encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link http://docs.Oracle.com/javase/7/docs/api
生成成功!