用户应该在编写代码的同时添加适当的文档注释,这样在代码编写、测试完成后可以直接通过JDK提供的javadoc.exe工具将源代码中的文档注释提取成一份标准的API文档。
Javadoc默认只处理用public、protected修饰的类、接口、构造方法、方法、属性、内部类之前的文档注释。
- 文档注释中常用的Html标签
超链接:<a href=”http://www.sohu.com">< /a>
段落:< p > </ p>
回车:< br/>
加粗:< b>< /b>
2.类或接口前的文档注释
@author:作者
@version:程序版本
@since:从指定JDK版本开始。
@see:参见可能会关心的类或接口。
3.方法或构造方法前的文档注释
@param:形式参数说明信息,建议一个形式参数占一行。
@return:方法的返回参数类型说明信息。
@throws:与@exception相同,方法可能抛出的异常信息说明。
@deprecated:指示该方法已经过时,不推荐使用。
@see:参见其他方法。
@link:指向其他Html文档的链接。