如何强制团队成员使用 eclipse 插件或其他东西发表评论
How to force team members to comment using eclipse plugin or something else
目前，我正在做一个新项目，由于没有评论，我很难理解。我想知道是否可以强制团队成员（包括我）添加更多评论。如果可能的话，我想稍后在 jenkins 中自动化这个项目。
您可以运行 静态代码检查及其相应的 eclipse 插件来强制在代码中进行注释。
例如在 CheckStyle javadoc 中可以强制执行 http://checkstyle.sourceforge.net/config_javadoc.html
checkstyle 也可以很容易地与 Jenkins 集成。
您还可以使用 eclipse java 编译器设置进行 javadoc 检查。
转到首选项->java->编译器->javadoc 以强制执行错误和警告。
可以通过持续构建轻松报告编译器错误和警告
干杯，
索拉夫
我只能建议对此非常非常小心。当然，您可以使用 SONAR、Eclipse Settings 等工具来强制注释。
呜呜呜呜呜：
- 您可以轻松生成注释 (/w Eclipse) 并且 - 正如您可能
知道生成的评论根本不是 use/helpful。
- 万一你添加了一个有用的评论，它太依赖于实际的实现，你也必须维护它。每当代码发生变化时，您都需要验证注释是否也发生了变化。这一点经常被忽视，并且由于根本没有任何评论而造成更多的混乱。虽然你一开始是出于好意。
- "The Truth Lies In The Code"(tm)：您可以通过非常努力地编写易于理解和易于维护的代码。这可能有助于避免根本不需要任何评论。这并不容易（而且并不总是可能），我承认。
- 至少 "public API" 必须记录在案。这可能是一个经验法则，并且在大型代码库中似乎是可以管理的。
相比 "forced comments"，我宁愿花更多的时间来编写易于理解的代码。你可能会通过强制执行而达到完全相反的效果。
不过，使用 Sonar/Eclipse 设置来强制执行 public API 的文档对我来说很有意义。
这需要在源代码管理级别实施，而不是 IDE 级别。
如果您正在使用 git，您可以查看 git 挂钩 http://git-scm.com/docs/githooks
这将让您编写小脚本，这些脚本在您提交代码时将成为 运行。您可以编写脚本来检查提交是否包含有效注释。您也许还可以使用“-force”选项或类似选项允许跳过评论。
目前，我正在做一个新项目，由于没有评论，我很难理解。我想知道是否可以强制团队成员（包括我）添加更多评论。如果可能的话，我想稍后在 jenkins 中自动化这个项目。
您可以运行 静态代码检查及其相应的 eclipse 插件来强制在代码中进行注释。
例如在 CheckStyle javadoc 中可以强制执行 http://checkstyle.sourceforge.net/config_javadoc.html
checkstyle 也可以很容易地与 Jenkins 集成。
您还可以使用 eclipse java 编译器设置进行 javadoc 检查。
转到首选项->java->编译器->javadoc 以强制执行错误和警告。 可以通过持续构建轻松报告编译器错误和警告
干杯，
索拉夫
我只能建议对此非常非常小心。当然，您可以使用 SONAR、Eclipse Settings 等工具来强制注释。
呜呜呜呜呜：
- 您可以轻松生成注释 (/w Eclipse) 并且 - 正如您可能 知道生成的评论根本不是 use/helpful。
- 万一你添加了一个有用的评论，它太依赖于实际的实现，你也必须维护它。每当代码发生变化时，您都需要验证注释是否也发生了变化。这一点经常被忽视，并且由于根本没有任何评论而造成更多的混乱。虽然你一开始是出于好意。
- "The Truth Lies In The Code"(tm)：您可以通过非常努力地编写易于理解和易于维护的代码。这可能有助于避免根本不需要任何评论。这并不容易（而且并不总是可能），我承认。
- 至少 "public API" 必须记录在案。这可能是一个经验法则，并且在大型代码库中似乎是可以管理的。
相比 "forced comments"，我宁愿花更多的时间来编写易于理解的代码。你可能会通过强制执行而达到完全相反的效果。
不过，使用 Sonar/Eclipse 设置来强制执行 public API 的文档对我来说很有意义。
这需要在源代码管理级别实施，而不是 IDE 级别。
如果您正在使用 git，您可以查看 git 挂钩 http://git-scm.com/docs/githooks
这将让您编写小脚本，这些脚本在您提交代码时将成为 运行。您可以编写脚本来检查提交是否包含有效注释。您也许还可以使用“-force”选项或类似选项允许跳过评论。