4

我正在将自定义检查添加为 eclipse-cs 插件,但遇到了一个问题。

我已经使用自定义检查创建了 java 文件。检查工作正常,但我无法更改自定义检查消息,因为该框不存在。

Java 文件如下所示:

package myCheck.checks;

import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;

public class MethodLimitCheck extends Check {

    private int max = 30;

    public int[] getDefaultTokens() {
        return new int[] { TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF };
    }

    public void setMax(int limit) {
        max = limit;
    }

    public void visitToken(DetailAST ast) {
        // find the OBJBLOCK node below the CLASS_DEF/INTERFACE_DEF
        DetailAST objBlock = ast.findFirstToken(TokenTypes.OBJBLOCK);
        // count the number of direct children of the OBJBLOCK
        // that are METHOD_DEFS
        int methodDefs = objBlock.getChildCount(TokenTypes.METHOD_DEF);
        // report error if limit is reached
        if (methodDefs > max) {
            log(ast.getLineNo(), "methodlimit", max);
        }
    }
}

配置框如下所示:

在此处输入图像描述

我无法从这里更改自定义消息。我希望 Box 看起来像这样,所以我可以从配置框中设置自定义消息:

在此处输入图像描述

在我的代码或任何文件中进行哪些更改才能使其正常工作?

4

1 回答 1

1

您可以简单地将自定义消息添加到您的checkstyle.xml

<module name="MethodLimitCheck">
    <property name="max" value="42"/>
    <message key="methodlimit" value="my test message default"/>
</module>

然后它将出现在 eclipse-cs 对话框中。在您的检查中,您可以使用getCustomMessages()方法 ( javadoc ) 访问自定义消息。

更新: 为了在 eclipse-cs 对话框中默认显示您的自定义消息而不将<message>元素添加到您的checkstyle.xml中,您必须为您的自定义检查创建一个messages.properties ,如“记录错误”下所述。然后,在包含自定义检查的 Eclipse 插件中,将元素添加到checkstyle-metadata.xml

<rule-metadata name="MethodLimit" internal-name="MethodLimitCheck" parent="TreeWalker">
    <alternative-name internal-name="com.foo.bar.MethodLimitCheck"/>
    <description>...</description>
    <!-- property-metadata -->
    <message-key key="methodlimit" />
</rule-metadata>
于 2013-08-15T12:17:48.663 回答