如何在推送之前让Mercurial要求文件拥有文档（Javadoc等）？

Question

这是通过扩展或本地功能目前可行吗？

感谢，

布兰登

Answer 1

你想一个pre-commit挂钩，会召唤出你的 “验证文档” 程序。然后基于对文档验证的响应，您可以允许/拒绝挂钩。

Answer 2

嗯，我忘了预先提交的钩子。

如果您在Java世界工作，您可以使用诸如checkstyle之类的工具来检查Javadocs是否为构建的一部分，以强制执行编码标准等，其中可能包括针对所有代码的Javadocs。

记录代码应该是每个开发人员的责任，他们应该把它放在心上。即使使用诸如checkstyle或使用预提交钩子等工具，也只能强制执行代码中存在的一些Javadoc，但不能控制文档的质量。

如果按照编码标准和坚实的同行代码审查良好做法，比如坚持，这将缓解需要汞柱检查代码前检查的Javadoc需要你。

只是我2C。