使用Javadoc生成API文档的方法:
- 方法一:
使用cmd,先找到文件所在文件夹,再输入javadoc HelloWorld.java即可,如图所示:
- 方法二:
使用eclipse,选中项目右键export,选择javadoc,进行导出,如果项目的编码格式是UTF-8,则需在VM中输入-encoding utf-8 -charset utf-8,点击finish即可导出,如图所示:
第一步:选择导出的路径:
第二步:设置编码格式:
关于使用javadoc的注意点:
1、Javadoc只能为public 和 protected成员进行文档注释。
2、在文档注释中,位于每一行开头的星号和前导空格都会被javadoc丢弃。
3、javadoc默认的编码是GBK,当代码的编码是UTF-8时,需要加入:-encoding utf-8 -charset utf-8,可以看方法二中的图片二;
4、不要在嵌入式html中使用标题标签,如<h1>
或<hr>
,因为javadoc会插入自己的标题,而你的标题可能同他们发生冲突:
如下:
生成的API文档效果如下:
注释风格:
1、///~: 标志源代码清单的结束;
2、/*output :表示输出的开始部分由这个文件生成,通过这种形式,它会被自动地验证其准确性。
代码风格:
- 类名的首字母大写;
- 驼峰风格:如果类名由几个单词构成,那么把它们并在一起,其中每个内部单词的首字母都大写形式,例如:
class AllTheColorOfTheRainbow{
int anIntegerColors;
void changeColor(int newHue){
//…
}
}