javaDoc命令是用来生成自己的API文档的
参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
package base;
/**
* @autor yeyue
* @version 1.o
* @since 1.8
*/
public class Doc {
String name;
/**
* @autor yeyue
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
命令生成DOC文档
javadoc -encoding UTF-8 -charset UTF-8 java类名称
IDEA生成DOC文档
- 找到工具菜单
- 配置号输出的目录和字符集(为了更好的适配中文),直接点OK即可。