Checkstyle冗长的解决方案？答案

【问题标题】：Solution for Checkstyle verbosity?Checkstyle冗长的解决方案？
【发布时间】：2010-08-16 09:28:12
【问题描述】：

在包含许多 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 */

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

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

【问题讨论】：

标签： java checkstyle verbosity

【解决方案1】：

您是否尝试过使用 allowMissingPropertyJavadoc 属性更新您的 Javadoc method Checkstyle configuration 以在 getter 和 setter 上不需要 javadoc？

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

【讨论】：

另一方的评论。对于我正在处理的一些代码，一些 setter 和 getter 具有标准 setter 和 getter 之外的副作用，因此您可能仍需要确保它们是文档。

【解决方案2】：

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

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

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

【讨论】：