前后端命名最佳实践

命名规范

最佳实践

命名是个困扰了我很久的问题，各种方式都试过，现在总结固化一下作为一个大结论。

原则：优先考虑小写、下划线，不用中划线。

1. 文件夹 小写 下划线

2. 文件名 小写 下划线

3. 样式名 小写 下划线

4. 类名 首字母大写 驼峰

5. 函数名 驼峰

6. 变量名 驼峰

7. 常量名 全大写 下划线

8. 数据库名 小写 下划线

9. 数据库表 小写 下划线

10. 字段名 小写 下划线

原因分析

用小写原因

1. Linux 系统是大小写敏感的，而 Windows 系统和 Mac 系统大小写不敏感
2. 某些系统（Ubuntu）的用户目录首字母大写（早期 Unix 系统 ls 大写的排前面），便于区分
3. 易读、易写

用下划线原因

1. 样式中使用容易复制，点击一次即可选中
2. 变量不支持中划线，支持下划线
3. 全部统一成下划线，省事省心

项目交付标准

低级

实现全部功能需求

解决全部 bug

合格

实现全部功能需求

解决全部 bug

代码格式统一(eslint 检测)、命名规范统一、极其详细的注释，代码合理的封装、隔离

走完前端上线必检清单，走完后端上线必检清单

需求文档、设计图、前端说明文档、后端接口文档、测试报告齐全

标准

实现全部功能需求

解决全部 bug

代码格式统一(eslint 检测)、命名规范统一、极其详细的注释，代码合理的封装、隔离

走完前端上线必检清单，走完后端上线必检清单

需求文档、设计图、前端说明文档、后端接口文档、测试报告齐全

后端接口单元测试报告、后端接口压力测试报告、运维部署说明

---

关注公众号 前端一锅煮，全栈学习分享中~