JavaDoc几种文档生成方式
JavaDoc命令是用来生成自己的API文档的
- 注释参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
生成文档
方法一:
-
打开CMD界面
-
进入java文件的真实目录内
-
输入命令:javadoc -encoding UTF-8 -charset UTF-8 java文件名
encoding与charset都是设置编码,使之适应中文
方法二使用eclipse生成文档:
-
选择菜单栏Project下的Generate Javadoc出现如下界面:
-
上图界面javadoc command设置为jdk\bin目录下的javadoc。exe,然后选中要生成文档的目标,点击next
-
第二页不做修改,继续next进入如下界面
-
在中间的大空白区域如上图输入-encoding UTF-8 -charset UTF-8,解决中文编码问题,点击finish