序言

提示

为什么开始讲规范？因为非常重要💕。

代码规范对于团队协作非常重要，使得编码可读性更强，成员轮岗更容易。如果代码风格各异，命名不规范注释不到位，那将是一场灾难。当代码不规范对于后来者将是一件很痛苦的事，🙁开发何必为难开发呢？编码不规范最大的好处就是，代码只有我懂，这个坑缺我不可✌️。

分类

1. css
2. html
3. js
4. git
5. README
6. 目录结构

实现

规范的实现，可以借助eslint、stylelint、prettier、husky、IDE以及团队约定

团队约定^强烈推荐

1. 项目结构
2. 配置信息^[1]
3. 命名
4. 注释
5. 版本
6. 文档
7. 其他

注意事项^必要

1. 团队的版本统一尤为重要，版本不同会引起不必要的问题，所以大家一定要注意。
2. 不要一味地追求新技术新版本，对于上线项目稳定才是王道，个人学习以及提升自己可以使用新技术新版本。
3. 说明文档同样很重要，说明文档必须体现出项目是干什么的、项目注意事项^[2]、scripts命令说明、文件结构^[3]、以及其他重要说明信息。

注释
[1] 如eslint、stylelint、prettier、husky以及其他配置。
[2] 有的项目在开发中可能会有注意事项，如有请写明避免踩坑。
[3] 一般大多项目文件结构基本统一，如有特殊情况请注明。