javadoc 中 @author、@version 和 @param 是类与方法文档的关键标签：@author 标明类作者（仅类级，允许多个）；@version 标识类版本（仅类级，唯一，推荐语义化版本）；@param 说明方法参数（需与签名一致，支持泛型标注）。

Javadoc 中的 @author、@version 和 @param 是常用文档标签，用于为类、方法等生成结构化说明。它们必须写在 Javadoc 注释块（/** ... */）内，且需紧贴注释开头，格式规范才可被正确解析。

@author 作者信息

标明当前类或接口的编写者，通常用于类级注释。一个类可有多个 @author，每行一个，支持姓名、邮箱或组织信息。

示例：

/** * 数据缓存管理器 * @author Zhang San * @author li.si@company.com */

注意：@author 不适用于方法或字段；若类经多人修改，建议保留原始作者并补充维护者。

@version 版本标识

记录类的版本号，常配合构建工具（如 Maven）自动注入。它只在类级注释中有效，每个类最多一个。

Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

常见写法：

• @version 1.2.0
• @version $Revision: 1234 $（SVN 变量替换）
• @version ${project.version}（Maven 属性）

不推荐写“初始版本”或“最新版”这类模糊描述，应使用语义化版本或时间戳。

@param 方法参数说明

用于方法、构造器的 Javadoc 中，说明每个形参的用途和约束。每个参数需单独一行，格式为 @param 参数名 描述文本。

示例：

/** * 根据用户ID查询用户详情 * @param userId 用户唯一标识，不能为空 * @param includeProfile 是否包含个人资料，true 表示加载 */

关键点：

• 参数名必须与方法签名完全一致（区分大小写）
• 若参数可能为 null，应明确说明“可为 null”或“不可为 null”
• 泛型参数（如 <t></t>）不用 @param，而用 @param <t></t>（带尖括号）

Java免费学习笔记：立即使用
解锁 Java 大师之旅：从入门到精通的终极指南