java - Checkstyle冗长的解决方案？

Question

在包含许多 getter 和 setter 的代码示例中，存在以下 CHECKSTYLE 符号：

/* CHECKSTYLE:OFF */
public void setDisplayName(final String displayName) {
    this.displayName = displayName;
}
/* CHECKSTYLE:ON */

/* CHECKSTYLE:OFF */
public String getDisplayName() {
    return displayName;
}
/* CHECKSTYLE:ON */

我发现这会使代码变得混乱，使其更难阅读。

有没有更简单的方法来添加这些符号，使它们不像本例那样位于每个方法定义的开头和结尾？

Answer 1

您是否尝试过使用 allowMissingPropertyJavadoc 属性更新您的Javadoc 方法 Checkstyle 配置，使其不需要 getter 和 setter 上的 javadoc？

根据您是在过滤 getter 和 setter javadoc 还是更复杂的东西之后，这可能是一个更好、更清洁的解决方案。

Answer 2

您引用的符号称为SuppressionCommentFilter，它使用成对的注释来抑制审计事件。您可以在单独的文件中维护它们，而不是在代码中包含这些抑制，如以下链接所述：SuppressionFilter

但是，根据您的情况，在代码中维护它是有原因的：

当这是问题代码而不是个人偏好的问题时，覆盖策略的最佳位置是代码本身。半结构化评论可以与支票相关联。这有时优于单独的抑制文件，在编辑源文件时必须保持最新。