Java 文档注释

Java 文档注释

Java 支持三种注释方式：

• 单行注释
• 多行注释
• 文档注释

前两种分别是 和 /* */，第三种被称作文档注释，它以 /** 开始，以 */ 结束。

前两种注释内容可以参考：Java 注释

文档注释允许你在程序中嵌入关于程序的信息。

你可以使用 javadoc 工具软件来生成信息，并输出到 HTML 文件中。

文档注释，使你更加方便的记录你的程序信息。

---

javadoc 标签

javadoc 工具软件识别以下标签：

标签	描述	示例
@author	标识一个类的作者	@author描述
@deprecated	指名一个过期的类或成员	@deprecated描述
{@docRoot}	指明当前文档根目录的路径	目录路径
@exception	标志一个类抛出的异常	@exception 异常名称说明
{@inheritDoc}	从直接父类继承的注释	从 immediate surperclass 继承注释。
{@link}	插入一个到另一个主题的链接	{@link 名称文本}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	插入指向另一个主题的内嵌链接。
@param	说明一个方法的参数	@param 参数名称说明
@return	说明返回值类型	@return说明
@see	指定一个到另一个主题的链接	@see锚
@serial	说明一个序列化属性	@serial描述
@serialData	说明通过 writeObject（ ） 和 writeExternal（ ）方法写的数据	@serialData描述