**JavaDoc命令是用来生成自己API文档的。**
- 参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本。
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况。
生成Doc文件步骤:
cmd法:
1.在IDEA里,右键 包/类 ,点击 show in explorer 进入文件夹
2.在文件夹的地址栏最前方输入cmd加空格进入命令提示符中。
3.在cmd中输入“ javadoc -encoding UTF-8 -charset UTF-8 文件名.java “后回车,编译完成之后在文件夹内会生成index文件,打开就会进入API文档
IDEA法
1.第一步:首先创建一个新的文件夹。
2.第二步:选中所要生成的包。
3.第三步:点击顶部工具(Tools)菜单,并选择生成javadoc(Generate JavaDoc)这个选项。
4.第四步:①然后会弹出一个界面,然后在输出目录(Output directory )输入框后面的按钮点击进去选择我们刚才创建的文件夹(JavaDoc),②然后在区域设置(locale框)里填写zh_CN,意思是这个代表的就是中文,③输完之后在下面的其他命令行式参框(Other command line arguments:)中输入下面这行编码-encoding utf-8 -charset utf-8,意思是用预先规定的方法将文字、数字或其它对象编成数码,或将信息、数据转换成规定的电脉冲信号。
5.点击OK后会在选中的文件夹里生成文件,打开JavaDoc文件夹,发现多了一堆东西,但我们只需要找到index.HTML文件,并打开之后就能看到生成的API文档了。