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

目前，我正在一个新项目中工作，由于没有评论，我很难理解。我想知道是否有可能强迫包括我在内的团队成员添加更多评论。如果可能的话，我希望稍后在jenkins中自动执行此JET。

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

例如，在CheckStyle中，可以强制执行javadoc

此外，checkstyle可以轻松地与Jenkins集成

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

转到preferences->java->compiler->javadoc以强制执行错误和警告。 编译器错误和警告可以通过连续构建轻松报告

干杯

---

索拉夫

我只能建议你对此要非常非常小心。当然，您可以使用SONAR、Eclipse设置等工具来强制执行注释

布乌特：

您可以很容易地生成注释/w Eclipse和-可能是这样 知道-生成的评论没有任何用处/帮助。 如果您添加了一条有用的注释，并且它过于依赖于实际的实现，那么您还必须维护它。每当代码更改时，您需要验证注释是否也更改。这一点经常被忽视，并且由于没有任何评论而造成更多的混乱。即使你一开始有个好的打算。 事实在于Codetm：通过努力工作，您可以获得易于理解且易于维护的代码。这可能有助于避免需要任何评论。我承认，这并不容易，也不总是可能的。 至少必须记录公共API。这可能是一条经验法则，在大型代码库中似乎是可以管理的。 我宁愿花更多的时间来编写好的可理解的代码，而不是强迫评论。你可以通过强制执行来达到完全相反的效果

---

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

这需要在源代码管理级别而不是IDE级别实现

如果您使用的是git，那么可以查看git挂钩

这将允许您编写在提交代码时运行的小脚本。您可以编写一个脚本来检查提交是否包含有效的注释。您还可以使用-force选项或类似的选项来允许跳过注释