简介

前端代码规范是基于业界标准规范文档，并结合团队项目业务需求以及在日常开发过程中总结提炼出的经验而制定。

致力于通过统一编码风格、增强团队开发协作、提高代码质量、普及最佳实践和代码缺陷检查帮助团队降低协作成本、提升前端项目的可维护性和稳定性。

此规范为参考规范，不全是硬性要求，部分硬性约定见下一条书写规范，统一团队编码规范和风格。目的是让所有代码都是有规可循的，并且能够得到沉淀，减少重复劳动。

背景

任何团队，规范都是怎么也绕不开的话题，我们有太多的理由去做规范。代码规范是软件开发领域经久不衰的话题，几乎所有工程师在开发过程中都会遇到，并或多或少会思考过这一问题。 无规矩不成方圆，无规范难以协同，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。

为什么需要规范？

在软件研发过程中，bug 越早发现，成本越低。代码扫描和单元测试，就是在早期帮我们发现程序中问题的有效手段。代码扫描不仅能帮我们发现程序的漏洞，也能督促开发人员更规范优雅地写代码。

当一个团队开始指定并实行编码规范的话，错误就会变得更加显而易见。 如果一段特定的代码不符合规范的话，它有可能只是代码风格错误，而也有可能会是 bug。指定规范就使得代码审核得以更好的开展，可以更精确的地定位到错误。

由于团队人数众多，合作开发，每个人风格各异，为了提高代码可读性、可维护性以及性能和兼容性，同时为了回避错误、小纠结和反模式，保证代码质量，便于团队协作，推行前端规范来对代码质量进行统一把控。主要针对的痛点如下：

• 项目数量增加和项目方案分离导致复杂度提升，进一步增加项目介入成本及维护成本
• 低质量代码容易遗漏到线上
• 没有统一的规范文档及工具，统一规范难以落地
• 人员风格差异性较大，沟通协调成本高
• 缺乏规范，导致代码风格不一，增加团队成员间的心理负担，极端情况下，某段代码只有某个人能修改

遵守规范的好处

• 降低新成员融入项目的成本, 同时也一定程度避免挖坑
• 提高代码整体的可读性、可维护性、可复用性、可移植性和可靠性，从根本上降低开发成本
• 保证代码的一致性，编码风格一致，也更加易于维护，因为团队内任何人都可以快速理解并修改。
• 提高开发效率、团队协作效率, 降低沟通成本,促进团队合作
• 规范是实现自动化的基础
• 实现高度统一的代码风格，减少 review 争议, 提高项目的可维护性
• 养成代码规范的习惯，有助于程序员自身的成长
• 规范是一个团队知识沉淀的直接输出

问题反馈

使用前端代码过程中如碰到问题，请到 Gitlab（目前还处于草稿状态中） 进行提问或者向该仓库提交 Pull Request，跟规范有关的 Lint 工具、CLI、配置文件都在仓库内。