首页 > 解决方案 > 我在 Checkstyle 配置文件中的哪里放置模块元素?

问题描述

我有一个简单的问题,当我运行 maven checkstyle,然后去检查有什么问题时,我有:

Line is longer than 80 characters (found 98).

有人知道如何设置超过 80 个字符吗?我在互联网上发现了一些东西,但他们没有告诉我需要把它放在哪里:

<module name="LineLength"> <property name="max" value="120"/> </module>

有人有线索吗?

亲切地

标签: mavencheckstyle

解决方案


通常,您需要将这些模块配置放入配置文件中,如下所示。
注意: LineLength的去向取决于 Checkstyle 版本。Checkstyle 8.24 及更高版本:直接在Checker下;Checkstyle < 8.24:在TreeWalker下。

Checkstyle 8.23 及更早版本的示例:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
    "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">

    <!-- FileSetChecks go here ("parent = Checker") -->

    <module name="TreeWalker">

        <!-- TreeWalker checks go here ("parent = TreeWalker") -->

        <module name="LineLength">
            <property name="max" value="120" />
            <property name="ignorePattern" value="^\s*\*\s*\S+$" />
        </module>

    </module>
</module>

正如另一个答案中提到的,您可以随后告诉 Maven 您的配置文件在哪里,或者您可以内联指定它(不推荐)。无论哪种情况,您都需要获取您现在正在使用的配置文件的副本,并对其进行修改。

在普通的旧 Maven Checkstyle 3.0.0 中,配置文件将是这个. 如果您在 Maven 配置中指定 Checkstyle 版本,请修改 URL 中的版本号以匹配它。


推荐阅读