Java Doc
JavaDoc命令用来生成自己的API文档
参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值清空
- @throws 异常抛出清空
示例
/**
* @author QiaoYun
* @version 1.0
* @since 1.8
*/
public class Main {
String name;
public static void main(String[] args) {
}
/**
*
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
生成API文档
-
打开Dos控制台
-
修改磁盘地址至java文件下
-
输入 javadoc 参数 java文件名
- 参数可有可无
- 如果文档注释存在中文,则可以使用参数设置字符集为中文
- 示例:javadoc -encoding UTF-8 -charset UTF-8
-
生成成功后,在存放java文件的文件夹下,找到index.html打开即可