如何禁用Java CheckStyle对文本块的行长度检查？

一、全局忽略文本块的行长度检查（推荐） #

SVG文本块本身通常会超长，全局配置能一次性解决所有同类问题：

1. 复制官方google-check.xml到项目目录（比如src/main/resources/google-check-custom.xml）
2. 找到其中的LineLength模块，添加ignoreTextBlocks="true"属性，让规则自动跳过文本块的行长度检查：

<module name="LineLength">
  <property name="max" value="100"/>
  <property name="ignoreTextBlocks" value="true"/>
</module>

3. 修改Maven CheckStyle插件配置，指定使用自定义的配置文件，同时确保插件适配Java 17语法：

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-checkstyle-plugin</artifactId>
  <version>3.2.1</version>
  <dependencies>
    <dependency>
      <groupId>com.puppycrawl.tools</groupId>
      <artifactId>checkstyle</artifactId>
      <version>10.7.0</version>
    </dependency>
  </dependencies>
  <configuration>
    <configLocation>src/main/resources/google-check-custom.xml</configLocation>
    <encoding>UTF-8</encoding>
    <source>17</source>
    <target>17</target>
  </configuration>
</plugin>

注：CheckStyle 10.6.0+默认支持Java 17文本块，无需额外启用，只要配置正确的Java源版本即可。

二、局部禁用单个文本块的行长度检查 #

如果仅需针对特定文本块关闭检查，可选择以下两种方式：

方法1：使用@SuppressWarnings注解 #

将注解直接标注在包含文本块的字段上方，注意规则名是小写的linelength：

@SuppressWarnings("checkstyle:linelength")
private static final String SVG_ICON = """
    <svg xmlns="http://www.w3.org/2000/svg" width="500" height="500" viewBox="0 0 500 500">
      <!-- 超长SVG内容 -->
    </svg>
""";

确保CheckStyle配置中启用了SuppressWarnings模块（google-check.xml默认已启用）：

<module name="SuppressWarnings"/>

方法2：使用注释开关//CHECKSTYLE:OFF/ON #

用注释包裹整个字段声明，明确指定关闭LineLength规则：

// CHECKSTYLE:OFF LineLength
private static final String SVG_ICON = """
    <svg xmlns="http://www.w3.org/2000/svg" width="500" height="500" viewBox="0 0 500 500">
      <!-- 超长SVG内容 -->
    </svg>
""";
// CHECKSTYLE:ON LineLength

注意：注释要紧贴字段，不要留空行，否则开关可能不生效。

常见问题排查 #

• 若@SuppressWarnings无效：检查规则名是否正确（是linelength而非LineLength），且注解放在字段的直接上方。
• 若文本块仍被检查：确认CheckStyle版本≥10.6.0，且Maven插件配置中指定了正确的Java源版本（<source>17</source>）。

内容的提问来源于stack exchange，提问作者theINtoy