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

Question

目前，我正在一个新项目中工作，由于没有评论，我很难理解。我想知道是否有可能迫使团队成员（包括我）增加更多评论。如果可能的话，我想在jenkins中自动化这个项目。

Answer 1

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

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

另外checkstyle可以很容易地与Jenkins集成。

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

转到preferences-> java-> compiler-> javadoc来执行错误和警告。 编译器错误和警告，可以通过持续构建

欢呼声，

Saurav

Answer 2

我只能建议是非常，非常小心，很容易的报道。当然，你可以使用诸如SONAR，Eclipse Settings之类的工具来执行注释。

Buuuuuuuut：

1. 您可以轻松地生成注释（/ W的Eclipse）和 - 作为你可能 的专有技术生成评价不使用/有益的。
2. 如果你添加一个有用的评论，并且它太依赖于实际的实现，你还必须维护它。每当代码更改时，您都需要验证注释是否也是如此。这经常被忽视，并且由于没有任何评论而造成更多混乱。尽管你首先有良好的打算。
3. “真相在于代码”（tm）：通过非常努力地工作，您可以实现良好的理解和易于维护的代码。这可能有助于避免需要任何评论。这不容易（并不总是可能的），我承认这一点。
4. 至少必须记录“公共API”。这可能是一个经验法则，它似乎可以在大型代码库中管理。

我宁愿花更多的时间去理解代码，而不是“强制评论”。您可以通过执行完全相反。

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

Answer 3

这需要在源控制级而不是IDE级执行。

如果你使用Git，你可以看看git的钩http://git-scm.com/docs/githooks

这将让你写，当你提交代码将运行的小脚本。您可以编写脚本来检查提交是否包含有效的评论。你也可以允许跳过带有“-force”选项或类似内容的评论。