1

我正在尝试编写自定义检查并从 Eclipse 中使用它。

我为此编写了一个 MethodLimitCheck.java 和一个 myChecker.xml 文件。


java文件:MethodLimitCheck.java

package myCheck;

import com.puppycrawl.tools.checkstyle.api.*;

public class MethodLimitCheck extends Check
{
    private static final int DEFAULT_MAX = 10;
    private int max = DEFAULT_MAX;

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

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

    @Override
    public void visitToken(DetailAST ast)
    {
        DetailAST objBlock = ast.findFirstToken(TokenTypes.OBJBLOCK);

        int methodDefs = objBlock.getChildCount(TokenTypes.METHOD_DEF);

        if (methodDefs > this.max) 
        {
            log(ast.getLineNo(),
                    "too many methods, only " + this.max + " are allowed");
        }
    }
}

和 xml 文件:myChecker.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
  <module name="TreeWalker">
    <module name="myCheckStyle.MethodLimitCheck">
      <property name="max" value="5" />
    </module>
  </module>
</module>

如何在 Eclipse 中使用此检查?

我从CheckStyle 站点中获取了这个示例。但是如何在 Eclipse 中使用它呢?

我需要在 eclipse 中获得警告,就像我使用可用检查并形成自定义配置时一样,可以从project->property->checkStyle.

我是这个工具的新手,所以如果我缺少一些基本的东西,请纠正我。

4

2 回答 2

3

你需要eclipse-cs插件。它将checkstyle集成到 eclipse 并允许提供自定义检查。另外,请查看sevntu.checkstyle。它是eclipse-cs插件的扩展。Sevntu.checkstyle添加了许多有用的检查并允许附加您自己的检查(请参阅 github 上的 wiki)。也许它包含您需要的检查。

于 2013-08-03T10:32:11.000 回答
1

您基本上必须编写自己的小 Eclipse 插件才能做到这一点。当插件工作时,您将在 eclipse-cs 提供的 Checkstyle 对话框中看到您的自定义检查。

这是一个关于如何做到这一点的教程,由 eclipse-cs 文档提供。还有示例代码。

一旦完成,整个事情似乎很简单。但请耐心等待,如果您是 Eclipse 插件的新手,可能需要一整天的时间才能真正掌握这一点。

于 2013-08-05T12:10:24.057 回答