利用javadoc能够简单的建立一个自己工程的api(html格式),并且可以给里面的所有方法添加注释。
在Eclipse项目中,选择Expert->Java->Javadoc。
弹出的选项有两点要注意:1,Command中选择jdk所在目录->bin->Javadoc
2,destination中选择保存路径
Javadoc的一些注释:
1,一般在代码的最头上是@version(版本)@author(作者名字)@since(jdk版本)
2,方法上面/**之内添加对方法的说明
/
@throw Exception(该方法可能出现的异常)
@return java.util.List或者int(表示该方法的返回值类型)