使用javadoc命令生成API文档
1. 编写代码,并添加注解
/**
* test
* @author admin
* @version 1.0
* @since 1.5
*/
public class APITest {
/**
* 计算两数的和
* @param a 整数
* @param b 整数
* @return 两数的和
*/
public int add(int a, int b ){
return a + b;
}
}
【注】
(1)注释要尽可能写的详细;
(2)注释格式为 `/………/** ,而不是
/………*/`
2.更改编码
- 可以使用 Notepad++ ,将要生成API文档的类的
.java
文件的编码格式改为ANSI编码(本地默认编码)
- 因为
.java
文件默认编码格式可能为UTF-8编码
,若不修改编码格式,生成的文档可能会有乱码
3.使命javadoc命令
- 输入
javadoc 类名.java
再回车之后,便会生成许多 html 文件,打开其中的index.html
便可看见刚刚生成的文档
还没有评论,来说两句吧...