JavaDoc是一种将注释生成API文档的技术。
- JavaDoc 参数信息
@author 作者名
@version 版本号
@since 指明需要最早使用jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况 -
在代码中添加文档参数
-
使用javadoc指令生成文档,这里的java文件的编码是UTF-8,所以要带上编码选项 -encoding UTF-8
-
打开文件夹中由该命令自动生成的index.html文件即可查看由注释生成的API文档
JavaDoc是一种将注释生成API文档的技术。