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

Question

这是目前通过扩展或本机功能可以实现的吗？

谢谢，

布兰登

Answer 1

你需要一个预先提交钩子来调用你的“验证文档”程序。然后根据对文档验证的响应，您可以允许/拒绝挂钩。

Answer 2

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

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

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

如果您遵循良好的做法，例如遵守编码标准和可靠的同行代码审查，它将减少您在检查代码之前要求Hg检查Javadoc的需要。

只是我的2c。