使代码文档成为提交（或构建）的自动化要求。

Question

我即将开始一个大型的.js项目，作为工作流程的一部分，我想强制执行代码文档。我倾向于JSDoc（2.x）。

理想情况下，我想拦截未记录的代码。我对以下任何事情感兴趣：

• 使用Grunt，Gulp或类似工具在开发人员的计算机上停止构建。
• 使用git hook来防止未记录的代码被推送到repo。
• 运行服务器端预部署检查并使构建失败。

Answer 1

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

我不知道你可以在服务器上实际运行的任何脚本; Git服务器不是很复杂，因为你可以随时撤消任何更改。

同样使文档成为一项要求对我来说听起来并不像是一种策略。通常需要文档来记录设计和代码中的错误和缺陷（即人们无法理解或使用产品没有 - 如果缺陷不存在，则无需解释如何用它）。

根据我的经验，您可以通过代码审查来确保质量保持高水平。