使代码文档成为提交(或构建)的自动化需求。

Question

我即将开始一个大规模的.js项目，作为工作流过程的一部分，我想执行代码文档。我倾向于JSDoc (2.x)。

理想情况下，我想拦截无文档的代码。我对任何东西都感兴趣

• 使用Grunt、Gulp或类似的工具在开发人员的机器上停止构建。
• 使用git挂钩，以防止无文档的代码被推到回购。
• 运行服务器端部署前检查，然后生成失败。

Answer 1

Git可以在客户端上运行脚本，在提交或推送代码之前进行一些检查。

我不知道您实际上可以在服务器上运行任何脚本；Git服务器并不复杂，因为您总是可以撤消任何更改。

对我来说，让文档成为一种需求听起来不像是一种策略。通常，文档是记录设计和代码中的错误和缺陷所必需的(也就是说，没有它，人们就无法理解或使用产品--如果没有缺陷，就没有必要解释如何使用它)。

根据我的经验，通过进行代码评审以确保质量保持在高水平，您会得到更好的结果。