如何让 Mercurial 在推送之前要求文件包含文档(Javadoc 等)?

发布于 2024-10-19 01:42:20 字数 51 浏览 1 评论 0原文

目前可以通过扩展或本机功能实现这一点吗?

谢谢,

布兰登

Is this something that is currently possible via extension or native functionality?

Thanks,

Brandon

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

长不大的小祸害 2024-10-26 01:42:20

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

You would want a pre-commit hook that would call out to your "validate document" program. Then based on the response to the document validation, you could permit/deny the hook.

慕巷 2024-10-26 01:42:20

嗯,我忘记了预提交挂钩。

如果您在 Java 领域工作,您可以使用 checkstyle 等工具来检查 Javadocs 作为您的构建强制执行编码标准等,其中可能包括为所有代码提供 Javadoc。

记录代码应该是每个开发人员的责任,他们应该牢记在心。即使使用 checkstyle 等工具或使用预提交挂钩,您也只能强制代码中存在一些 Javadoc,而无法控制文档的质量。

如果您遵循良好的实践,例如遵守编码标准和可靠的同行代码审查,那么您就不需要 Hg 在签入代码之前检查 Javadocs。

只是我的 2c。

Hmm, I forgot about pre-commit hooks.

If you are working in the Java world, you could use tools such as checkstyle to check for Javadocs as a part of your build to enforce coding standards and such which may include having Javadocs for all code.

Documenting code should be each developers responsibility and they should take it to heart. Even with tools such as checkstyle or using a pre-commit hook, you can only enforce some Javadocs being present in the code but not control the quality of the documentation.

If you follow good practices such as adherence to coding standards and solid peer code reviews, it will alleviate the need for you requiring Hg to check for Javadocs before checking code in.

Just my 2c.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文