checkstyle不支持直接强制类头含@author或@version注解，但可通过javadoctype规则检查类级javadoc中必须包含@author和@version标签，或结合missingannotation（需自定义注解）、regexpheader等方案实现。

Checkstyle 本身不直接支持“类头必须包含 @Author 或 @Version 注解”这种语义级检查，因为 Java 标准库中没有 @Author 和 @Version 这两个内置注解（它们属于 Javadoc 标签 @author 和 @version），而 Checkstyle 的注解相关规则（如 SuppressWarnings、MissingDeprecated）默认只处理标准注解或可声明的 @interface。

但你可以通过组合两种方式实现「强制类声明处有 author/version 信息」的效果：

---

✅ 方式一：用 JavadocType 检查类级 Javadoc 中必须含 @author 或 @version

这是最常用、最符合 Java 规范的做法（@author/@version 是 Javadoc 标签，不是运行时注解）。

在 checkstyle.xml 中配置：

<module name="JavadocType"><property name="authorFormat" value="\S+"></property><property name="versionFormat" value="\S+"></property><property name="scope" value="public"></property><property name="excludeScope" value="private"></property><property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF"></property><!-- 至少要有 author 或 version 中的一个 --><property name="allowMissingAuthor" value="false"></property><property name="allowMissingVersion" value="false"></property></module>

⚠️ 注意：

• allowMissingAuthor="false" 表示必须存在 @author；
• allowMissingVersion="false" 表示必须存在 @version；
• 如果你希望「二者至少一个存在」，Checkstyle 原生不支持「OR 逻辑」，需改用下面的自定义方案，或接受「双强制」策略（推荐团队统一要求两者都写）。

✅ 示例合法类头：

/**
 * 工具类。
 * @author ZhangSan
 * @version 1.2.0
 */
public class StringUtils { }

❌ 缺任一就会报错。

Alibabacloud Sdk Client Initialization For Java

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

下载

---

✅ 方式二：用自定义注解 + AnnotationOnSameLine / MissingAnnotation（需额外定义注解）

若你坚持用真实注解（如 @Author("ZhangSan")），需：

1. 定义自己的注解类型（保留策略为 SOURCE 或 CLASS）：

   @Documented
   @Retention(RetentionPolicy.SOURCE)
   @Target(ElementType.TYPE)
   public @interface Author {
       String value();
   }
   
   @Documented
   @Retention(RetentionPolicy.SOURCE)
   @Target(ElementType.TYPE)
   public @interface Version {
       String value();
   }

2. 在 checkstyle.xml 中启用 MissingAnnotation 规则（Checkstyle 8.36+ 支持）：

   <module name="MissingAnnotation"><property name="annotationNames" value="Author,Version"></property><property name="tokens" value="CLASS_DEF, INTERFACE_DEF"></property><property name="maxAnnotationsPerElement" value="2"></property></module>

   此规则会检查类定义上是否缺失指定注解 —— 但它不支持 OR 语义，即 Author 和 Version 都会被视为“必须存在”，除非你写自定义 Checkstyle 模块。

---

✅ 方式三（进阶）：用正则 + RegexpHeader 检查类文件开头注释块

如果你允许把 @author/@version 写在文件头注释（非 Javadoc），可用 RegexpHeader 匹配固定格式头部：

<module name="RegexpHeader"><property name="header" value="^/\*\*\n \* @author .+\n \* @version .+\n \*/$"></property><property name="fileExtensions" value="java"></property></module>

⚠️ 缺点：耦合文件结构，不校验是否在类定义上方，且无法区分多个类。

---

? 补充建议

• 推荐优先使用 JavadocType + @author/@version Javadoc 标签，这是 Java 社区通用实践，IDE 和文档工具（如 Javadoc）原生支持；
• 若项目已用 Lombok，注意 @Data 等注解可能影响 JavadocType 对类定义的识别，建议 tokens 明确限定；
• 所有配置需放在 TreeWalker 模块内（Checkstyle 8.x+ 结构）：

  <module name="Checker"><module name="TreeWalker"><module name="JavadocType"> ... </module></module></module>

---

不需要写插件或编译期处理，纯 XML 配置即可生效。集成到 Maven 或 IDEA 后，保存即提示。

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