【发布时间】：2015-06-22 10:44:44
【问题描述】：
目前，我正在从事一个新项目，由于没有评论，我很难理解。我想知道是否可以强制团队成员（包括我）添加更多的 cmets。如果可能的话，我想稍后在 jenkins 中自动化这个 ject。
【问题讨论】：
标签： eclipse jenkins eclipse-plugin coding-style build-automation
【发布时间】：2015-06-22 10:44:44
【问题描述】：
您可以运行静态代码检查及其对应的 eclipse 插件以强制在代码中生成 cmets。
例如在 CheckStyle javadoc 中可以强制执行http://checkstyle.sourceforge.net/config_javadoc.html
checkstyle 也可以很容易地与 Jenkins 集成。
您还可以使用 eclipse java 编译器设置进行 javadoc 检查。
转到首选项->java->compiler->javadoc 以强制执行错误和警告。 通过持续构建可以轻松报告编译器错误和警告
干杯，
苏拉夫
【讨论】：
我只能建议非常非常小心。当然，您可以使用 SONAR、Eclipse Settings 等工具来强制执行 cmets。
呜呜呜：
- 您可以轻松地生成 cmets (/w Eclipse) 并且 - 可能 知道生成的评论根本没有用/没有帮助。
- 如果您添加了有用的注释并且它过于依赖实际的实现，您还必须对其进行维护。每当代码更改时，您都需要验证注释是否也发生了变化。这经常被忽视，并造成更多的混乱，然后根本没有任何评论。即使你一开始的意图是好的。
- “代码中的真相”(tm)：通过努力工作，您可以获得易于理解且易于维护的代码。这可能有助于避免需要任何评论。我承认这并不容易（而且并不总是可能）。
- 至少必须记录“公共 API”。这可能是一个经验法则，并且在大型代码库中似乎可以管理。
我宁愿花更多的时间来编写易于理解的代码，而不是“强制 cmets”。你可以通过强制执行来达到完全相反的效果。
不过，使用 Sonar/Eclipse 设置强制记录公共 API 对我来说很有意义。
【讨论】：
这需要在源代码控制级别而不是 IDE 级别实现。
如果你使用 git，你可以查看 git hooks http://git-scm.com/docs/githooks
这将让您编写将在您提交代码时运行的小脚本。您可以编写一个脚本来检查提交是否包含有效的评论。您也可以使用“-force”选项或类似选项允许跳过 cmets。
【讨论】：