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 method Checkstyle configuration以获取getter和setter上的javadoc？

根据你是否只是过滤了getter和setter javadoc或更复杂的东西，这可能是一个更好，更清洁的解决方案。

Answer 2

您引用的表示法称为 SuppressionCommentFilter ，它使用注释对来抑制审核事件。您可以将其保存在单独的文件中，而不是在代码中进行这些抑制，如此链接中所述：SuppressionFilter

但是根据您的具体情况，有理由在代码中维护它：

  

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