如何使用eclipse插件或其他方法强制团队成员发表评论

Question

目前，我正在开展一个新项目，因为没有评论，我很难理解。我想知道是否有可能强迫团队成员（包括我）添加更多评论。如果可能的话，我想稍后在jenkins中自动化这个ject。

Answer 1

您可以运行静态代码检查及其相应的eclipse插件来强制执行代码中的注释。

例如在CheckStyle中，javadoc可以强制执行http://checkstyle.sourceforge.net/config_javadoc.html

checkstyle也可以轻松与Jenkins集成。

您还可以使用eclipse java编译器设置进行javadoc检查。

转到偏好设置＆gt; java-＆gt;编译器＆gt; javadoc以强制执行错误和警告。 编译器错误和警告可以通过持续构建轻松报告

欢呼声，

Saurav

Answer 2

我只能建议非常非常小心。当然，您可以使用SONAR，Eclipse Settings等工具来强制执行注释。

Buuuuuuuut：

1. 你可以很容易地生成评论（/ w Eclipse）和 - 知道的评论根本不是用处/有用的。
2. 如果您添加有用的注释并且它过分依赖于实际实现，您还必须维护它。每当代码更改时，您需要验证注释是否也是如此。这经常被忽视，并且由于没有任何评论而产生更多混淆。即使你首先有一个好意图。
3. “真相存在于代码中”（tm）：通过努力工作，您可以获得良好的理解和易于维护的代码。这可能有助于避免需要任何评论。这不容易（并不总是可能），我承认。
4. 至少必须记录“公共API”。这可能是一个经验法则，它似乎可以在大型代码库中管理。

我宁愿花更多的时间来使用易于理解的代码而不是“强制评论”。你可以通过强制执行来完成相反的工作。

使用Sonar / Eclipse设置强制执行公共API的文档对我来说很有意义。

Answer 3

这需要在源控制级别而不是IDE级别实现。

如果你正在使用git，你可以查看git hooks http://git-scm.com/docs/githooks

这将允许您编写将在提交代码时运行的小脚本。您可以编写脚本来检查提交是否包含有效注释。您也可以允许使用＆＃34; -force＆＃34;跳过评论。选项或类似的东西。