Javadoc的参数和生成

Javadoc的参数和生成

作用

用来生成自己的API文档

参数信息

@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本号
@param 参数名
@return 返回值情况
@throws 异常抛出情况

添加方法

加在类上或者方法上

步骤：输入"/**" + 回车，然后输入需要的参数

生成doc文档的方法

1. 通过命令行窗口：在文件路径下打开命令行窗口，输入

   javadoc -encoding UTF-8 -charset UTF-8 Doc.java //中间的为参数，最后为文件名
   

2. 通过IDEA：选择上方tools选项中的Generate JavaDoc,设置好其中的JavaDoc范围，导出路径，语言和参数等，再点击ok即可