我们需要在团队项目Java代码中执行评论的用法。由于我们已经在使用Jenkins，因此最好使用可以根据是否编写注释来使构建成功/失败的插件。选项包括使用CheckStyle，Git Hooks或Sonar插件来执行相同的操作。感谢任何设置此设置的指针或技巧。
请注意，我们打算将Javadocs用于评论目的。
使用jenkins的CheckStyle插件是一个可行的选择。
，它甚至可以满足您对" 导致构建成功/失败的要求"'t想要这样做，因为CheckStyle还可以通过许多其他方式帮助提高代码质量和一致性。
构建选项包括：
-
如果CheckStyle错误的数量超过了一定的绝对限制，则配置Jenkins项目构建将失败。（例如，如果CheckStyle错误的数量为> 300。）
-
如果CheckStyle错误的数量超过了以上构建的错误数量，则配置Jenkins项目构建将失败。（例如，如果检查风格错误的数量比以前的构建大50多。）
但是，我相信这两种方法都适用于所有构建。我认为您不能以每项项目为基础设置这些阈值。
其他值得注意的点要注意使用CheckStyle进行治安Javadoc评论：
-
可以自定义任何CheckStyle错误消息以满足您的需求。
-
您可以使用允许在Getters/setter上丢失评论，请允许MissingPropertyjavadoc 。
-
您可以使用 ignoremethodnamesregex 。
-
您可以使用 MinlineCount 。
-
您可以配置CheckStyle接受Javadoc评论，该评论与方法的签名，返回类型和抛出异常不完全匹配，并使用 allowmissingthrowstags ， allymissingmissingmissingmissingReturntag >允许的Paramtags （尽管我不清楚为什么有人愿意这样做）。
很容易识别checkstyle不完美的特定领域，当然不会（不能）查看您的评论质量，但是这些不是不使用它的论点。不要让完美成为善良的敌人；CheckStyle将验证Javadoc评论的最低要求。