javadoc简介

一、功能简介

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

二、使用简介

1、注释规范

Javadoc用于描述类或者方法的作用，规定每一段注释都要写在对应的类上面和方法上面。
而写在类上的文档标注一般分为三段：

第一段：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束
第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注作者、创建时间、参阅类等信息

示例：

package java.lang;

/**
 * Class {@code Object} is the root of the class hierarchy.
 * Every class has {@code Object} as a superclass. All objects,
 * including arrays, implement the methods of this class.
 */
public class Object {}

2、标签使用简介

(1) @author

一般使用这个标签标记作者，在有多个作者时可以多次使用这个标签，如

/**
* @author LiHua
*/

(2) @version

此标签用于标记版本号

(3) @return

此标签用于注释函数返回值

(5) @param

此标签用于注释方法的参数

(6) @see

此标签用于引用，查看相关的内容，如类，方法，变量等

(7) @since

此标签记录文件创建时间，一般后跟当时的版本号或时间

(8) @deprecated

此标签用于标识过期API，虽然为了保证兼容性仍存在，但不推荐使用

(9) @throws

此标签用于描述构造函数或方法抛出的异常

(10) @exception

同@throws

(11) {@value}

该标签对常量注释，如果其值包含在文档中，通过改标签引用常量的值

(12) @inheritDoc

该标签用于继承父类中的Javadoc，将父类的文档注释继承到子类

(13）{@link 包名.类名#方法名(参数类型)}

该标签用于快速链接到相关代码

(14) {@code}

该标签以{@code text}的格式 将文本标记为code