我们需要在团队项目java代码中强制使用注释。由于我们已经在使用Jenkins，因此我们最好使用一个插件，它可以根据是否写入注释使构建成功/失败。选项包括使用Checkstyle，git hooks或SONAR插件来强制执行相同的操作。感谢任何指针或提示来设置它。
请注意，我们打算使用Javadocs进行评论。
答案 0 :(得分：0)
使用Checkstyle plugin for Jenkins是一个可行的选择。
它甚至可以满足您对<＃34; 的要求，导致构建成功/失败，具体取决于是否撰写了评论＆＃34;如果将Checkstyle配置为仅检查与评论相关的问题，但您可能不想这样做，因为Checkstyle还可以通过许多其他方式帮助提高代码质量和一致性。
构建选项包括：
如果Checkstyle错误的数量超过某个绝对限制，则将Jenkins项目构建配置为失败。 （例如，如果Checkstyle错误的数量> 300，则失败此构建。）
如果Checkstyle错误的数量超过先前构建的错误数量某个已定义的阈值，则将Jenkins项目构建配置为失败。 （例如，如果Checkstyle错误的数量比之前的版本大50以上，则使此版本失败。）
但是，我相信这两种方法都是系统范围的，适用于所有版本。我不认为您可以按项目设置这些阈值。
关于使用Checkstyle for policing Javadoc comments值得注意的其他要点：
可以自定义任何Checkstyle错误消息以满足您的需求。
您可以使用 allowMissingPropertyJavadoc 在getter / setter上允许缺少评论。
您可以指定使用 ignoreMethodNamesRegex 忽略符合某些正则表达式的方法名称。
您可以指定允许低于特定行数阈值的方法使用 minLineCount 省略Javadoc注释。
您可以使用 allowMissingThrowsTags ， allowMissingReturnTag 将Checkstyle配置为接受与方法的签名，返回类型和抛出异常不完全匹配的Javadoc注释>和 allowMissingParamTags （虽然我不清楚为什么有人会这样做）。
很容易识别Checkstyle不完美的特定区域，当然它不会（不能）审查你的评论的质量，但那些不是不是的论据使用它。不要让完美成为善的敌人; Checkstyle将验证是否满足Javadoc注释的最低要求。