什么是JavaDoc
示例
package se;
/**
* 用于学习Java
* @author Admin
* @version 1.0
* @since 1.8
*/
public class Test20240119 {
/**
* 主方法
* @param args
*/
public static void main(String[] args) {
// 你好,世界
System.out.println("Hello world");
}
}
写一个java文件,加一下文档注释,找到这个java文件的位置,进入cmd,输入
javadoc -encoding UTF-8 -charset UTF-8 Test20240119.java
得到结果如下:
在当前文件夹下可以看到生成好的html文件
点击index.html,进入查看,效果如下图:
IDEA生成JavaDoc
在工具下找到生成JavaDoc
配置如下方式,点击确定即可生成: