java - 有关检查样式的提示

Question

我是 CheckStyle 的新手，对于某些情况我没有任何好主意。

示例 1

 void loadThumbnail(Context context, int resize, Drawable placeholder, ImageView imageView, Uri uri);

正如你所见，该方法的长度太长。所以我使用:

     <module name="LineLength">
       <property name="max" value="100"/>
    </module>
    <module name="MethodLength">
        <property name="max" value="140"/>
    </module>

似乎MethodLength被LineLength覆盖了

示例 2

当我将链接放入评论中时，例如:

https://android.googlesource.com/platform/frameworks/base/+/refs/heads/master/media/java/android/media/MediaFile.java

显然这个链接太长了。我该如何处理它？<​​/p>

Answer 1

很高兴您正在研究 Checkstyle!对于许多任务来说，它都是一个很好的工具，尽管它远非完美，也绝不是所有问题的解决方案。

关于LineLength和 MethodLength检查:这些实际上检查两个非常不同的东西:

• LineLength 检查文件中文本行的实际长度
• MethodLength 检查方法中的行数(是的，是行数，而不是语句，这就是 ExecutableStatementCount 的用途)

因此，您通常会启用LineLength和MethodLength(或ExecutableStatementCount，我更喜欢它而不是MethodLength) .

LineLength 必须配置为处理无法缩短的长行，例如您的链接示例。 Checkstyle 的最新版本默认处理 package 和 import 语句。该检查还具有一个 ignorePattern 功能，您可以设置它来过滤掉其他长行。文档给出了这个例子:

<module name="LineLength">
   <property name="ignorePattern" value="^ *\* *[^ ]+$"/>
</module>

在此示例中，Javadoc 仅包含一个单词的行(这里指的是除了星号后面没有空格)，无论其长度如何，都不会被标记。这样，您应该能够涵盖大部分案例。