使用IDEA生成JavaDoc
使用IDEA生成JavaDoc
文档注释参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的JDK版本
- @param 参数名
- @return 参数名
- @throw 异常抛出情况
示例代码:
/**
* @author DT
* @version 1.0
* @since 8.0
*/
public class Doc {
String name;
/**
* @author DT
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
关于JavaDoc的IDEA参数设置
IDEA-工具(Tool)-生成JavaDoc
-
选择需要生成JavaDoc范围
-
选择生成JavaDoc的文件输出目录
-
填入其他命令行参数
-encoding UTF-8 -charset UTF-8
设置完后点击确认,则会立即使用IDEA在输出目录下生成JavaDoc,可以用浏览器打开查看相关信息