有没有办法忽略Checkstyle中FileLength检查的注释和空格

Question

我是checkstyle的新手，并且已经花了足够的时间做一些我认为应该轻松杀人的事情。我想检查一下我文件中的行数，这是我成功完成的。但是，在抛出有关大小违规的错误之前，我无法将checkstyle配置为忽略空行以及Java注释。

阅读他们的文档我认为FileLength模块没有任何可用于忽略注释和空格的属性。这是链接和示例代码 http://checkstyle.sourceforge.net/config_sizes.html

<module name="FileLength">
  <property name="max" value="500"/>

唯一的其他公开属性是 fileExtensions 。有人可以建议什么是最好的方式来点击fileSize以及不阻止开发人员输入详细的文件？

Answer 1

这是一个很好的问题。首先，无法以您需要的方式配置 FileLength 检查。它只是用于行数，包括强制版权声明标题或诸如此类的所有内容。

所以，我这样做是：

• 使用大量的行（例如1500）检查 FileLength ，这样即使是评论很好的文件也不应合法达到该限制。
• 使用 ExecutableStatementCount 将方法限制为一定数量的语句。这将排除注释和格式，这些注释和格式将大括号放在自己的行上。根据我的经验，这里的好价值是60. MethodLength 现在可以被禁用。
• 使用 MethodCount 来限制方法的数量。

现在，通过将 MethodCount 和 ExecutableStatementCount 的值相乘，您将获得与您所描述的限制，这是对每个类的语句数量的限制，而不是对行数的限制。

实际值必须进行一些调整，因此请准备好在项目期间更改它们几次。