我们如何在jenkins上强制为团队项目编写java注释？

Posted 2021-04-15

我们需要在团队项目java代码中强制使用注释。由于我们已经在使用Jenkins，因此我们最好使用一个插件，它可以根据是否写入注释使构建成功/失败。选项包括使用Checkstyle，git hooks或SONAR插件来强制执行相同的操作。感谢任何指针或提示来设置它。

请注意，我们打算使用Javadocs进行评论。

答案

使用Checkstyle plugin for Jenkins是一个可行的选择。

如果将Checkstyle配置为仅检查与评论相关的问题，它甚至可以满足您的要求“根据是否写入评论使构建成功/失败”，但您可能不希望这样做，因为Checkstyle可以还有助于以其他许多方式提高代码质量和一致性。

构建选项包括：

• 如果Checkstyle错误的数量超过某个绝对限制，则将Jenkins项目构建配置为失败。 （例如，如果Checkstyle错误的数量> 300，则失败此构建。）
• 如果Checkstyle错误的数量超过先前构建的错误数量某个已定义的阈值，则将Jenkins项目构建配置为失败。 （例如，如果Checkstyle错误的数量比前一个版本大50以上，则失败此构建。）

但是，我相信这两种方法都是系统范围的，适用于所有构建。我认为您不能在每个项目的基础上设置这些阈值。

关于使用Checkstyle for policing Javadoc comments值得注意的其他要点：

• 可以自定义任何Checkstyle错误消息以满足您的需求。
• 您可以使用allowMissingPropertyJavadoc在getter / setter上允许缺少注释。
• 您可以使用ignoreMethodNamesRegex指定将忽略符合某些正则表达式的方法名称。
• 您可以指定允许低于特定行数阈值的方法使用minLineCount省略Javadoc注释。
• 您可以使用allowMissingThrowsTags，allowMissingReturnTag和allowMissingParamTags将Checkstyle配置为接受与方法的签名，返回类型和抛出的异常不完全匹配的Javadoc注释（尽管我不清楚为什么有人想要这样做）。

很容易识别Checkstyle不完美的特定区域，当然它不会（不能）审查您的评论质量，但这些不是不使用它的论据。不要让完美成为善的敌人; Checkstyle将验证是否满足Javadoc注释的最低要求。