我们需要在团队项目java代码中强制使用注释。由于我们已经在使用Jenkins,因此我们最好使用一个插件,它可以根据是否写入注释使构建成功/失败。选项包括使用Checkstyle,git hooks或SONAR插件来强制执行相同的操作。感谢任何指针或提示来设置它。
请注意,我们打算使用Javadocs进行评论。
使用Checkstyle plugin for Jenkins是一个可行的选择。
如果将Checkstyle配置为仅检查与评论相关的问题,它甚至可以满足您的要求“根据是否写入评论使构建成功/失败”,但您可能不希望这样做,因为Checkstyle可以还有助于以其他许多方式提高代码质量和一致性。
构建选项包括:
但是,我相信这两种方法都是系统范围的,适用于所有构建。我认为您不能在每个项目的基础上设置这些阈值。
关于使用Checkstyle for policing Javadoc comments值得注意的其他要点:
很容易识别Checkstyle不完美的特定区域,当然它不会(不能)审查您的评论质量,但这些不是不使用它的论据。不要让完美成为善的敌人; Checkstyle将验证是否满足Javadoc注释的最低要求。