个人编码规范
规范是以实践经验为基础,总结出兼备开发效率、程序执行效率、扩展性和安全性等最佳实践。当然,项目规范并不是一成不变,随着实践经验的丰富、视野的拓宽、优秀理念的吸收,我们的编程观念也会改变,项目规范也会更新。
这里收集了我个人所有项目的规范以供参考。
规范的优势
- 高效编码 —— 避免做过多的 “决策选择” 而导致时间的浪费
- 风格统一 —— 统一代码风格,阅读别人写的代码就像阅读自己写的代码一样
- 减少错误 —— 遵循规范的实践,能有效避免一些坑,也能减少初级错误
开发哲学
- DRY —— “Don’t Repeat Yourself” 不写重复代码
- 约定俗成 —— “Convention Over Configuration”,优先选择官方、框架以及社区提倡的做法
- KISS —— “Keep it Simple,Stupid”,提倡简单易读的代码,不写高深、晦涩难懂的代码
- 最少配置 —— 对所有构建工具、项目等配置应尽可能使用默认选项,尽可能复用重复配置
- 最少权限 —— 只分配完成工作所需的权限
- 进行面向对象编程时,应遵循 SOLID 原则