Javadoc 标签使用指南

Javadoc 标签使用指南
Javadoc 是一种用于生成 Java 代码文档的工具。本指南提供了常用 Javadoc 标签的用法和示例。
基本标签

@author
用途： 指定类的作者。
示例：
@author John Doe

@deprecated
用途： 标记类、方法或字段已过时。
示例：
@deprecated

@exception
用途： 描述方法可能抛出的异常。
示例：
@exception IOException if an I/O error occurs

@param
用途： 描述方法的参数。
示例：
@param name the name of the person

@return
用途： 描述方法的返回值。
示例：
@return the greeting message

@see
用途： 提供到其他类或方法的参考链接。
示例：
@see java.util.List

@since
用途： 指定引入 API 的版本。
示例：
@since 1.2

@serial
用途： 为序列化字段和类提供文档。
示例：
@serial

@serialData
用途： 描述序列化数据。
示例：
@serialData

@throws
用途： 描述方法可能抛出的异常。
示例：
@throws IOException if an I/O error occurs

@version
用途： 指定类的版本信息。
示例：
@version 1.0

高级标签
@inheritDoc
用途： 从超类继承文档注释。
示例：
@inheritDoc

@link
用途： 创建到另一个类或成员的链接。
示例：
{@link java.util.List}

@linkplain
用途： 创建纯文本形式的链接。
示例：
{@linkplain java.util.List}

@value
用途： 显示常量的值。
示例：
{@value #MAXVALUE}

自定义标签
Javadoc 允许使用自定义标签，格式为 @标识符。自定义标签的内容不会直接出现在生成的文档中，除非使用 -tag 选项指定处理方式。
示例：
@author
@tag customTag This is a custom tag.
这个文档提供了一个快速参考，以帮助开发者了解如何使用 Javadoc 标签来注释他们的 Java 代码。每个标签的示例都展示了如何在代码中使用它。记得，为了生成文档，这些标签必须放在有效的 Javadoc 注释块中（即被 /** ... */ 包围）。