JavaDoc
javadoc命令是用来生成自己API文档的
参数信息
- @author作者名
- @version 版本号
- @since指明需要最早使用的jdk版本
- @param 参数名
- @return返回值情况
- @throws 异常抛出情况
代码演示
package rjxh_study.doc;
/**
* @author 瑾
* @version 1.0
* @since 15
*/
public class Doc {
String name;
/**
* @author 瑾
* @param name
* @return
* @throws Exception
*/
public String test(String name)throws Exception{
return name;
}
}
右键选择
- 命令行前加cmd即可打开
- IDEA生成javadoc文档
生成完成: