* [ ] 编码规范不仅仅可以保证代码有很高的可读性,长久的编码规范还会产生巨大的沉淀价值 。
* [ ] 那么团队、以及企业应该如何进行编码规范呢?
<br><br>
>[info]### **真正地编码规范的建立与完善,需要三个步骤来完成:**
<br><br>
第一步,建立企业级公共代码库。由于今天的软件产品开发项目已不大可能是从零编码了,大量的第三方组件、以及成功项目的可复用代码节约了项目组大量地开发时间,也是软件企业宝贵的技术财富,因此,我们需要将应用到了企业产品中的这些组件、复用代码识别出来,并收归组织级进行统一管理,形成公共代码库,提供给企业内所有的项目开发使用。
*****
<br><br>
第二步,建立公共代码的使用规范。有了公共代码库以后,我们需要对库中每一个组件、可复用代码等建立详细的使用规范说明文档,其中应包括:组件或代码的名称、版本、使用场景、优缺点、接口调用方式等,而这就已经形成了初步的编码规范文档了,在这一基础之上,再建立对接口调用代码编写的规范化,保证每一个项目在使用同一控件或复用代码时,其使用方法和编写代码都是统一的,具有可读性等要求,逐步完善规范。
*****
<br><br>
第三步,建立企业级基础框架代码和完善编码规范。企业还需要基于已建立的公共代码库,继续建立起基础框架代码,组织内所有的软件产品开发都应在基础框架代码上实现。这时的编码规范还应根据基础框架的代码编写要求进行适时同步更新,比如:强调代码的可读性、执行效能,以及代码的优化或重构等要求。
- 序言
- 为什么要编码规范?
- 如何进行编码规范?
- 编码规范宏观微观细节
- PHP编码规范
- 基础规范
- 1 语法规范
- 2 变量命名规范
- 3 常量命名规范
- 4 类命名规范
- 5 函数命名规范
- 6 方法命名规范
- PSR-规范
- 基本代码规范
- Tp项目规范
- TP命名规范
- Tp目录规范
- Tp基础目录构架
- Tp项目开发思考
- Tp控制器规范
- 控制器构架
- Tp模型规范
- 模型性能优化
- Tp业务规范
- 返回结构规范
- 业务异常规范
- Tp输出规范
- Restful API
- 模板渲染输出
- Tp异常规范
- 异常码状态码
- 异常输出方式
- Tp验证规范
- Tp路由规范
- Tp加密规范
- Password Hashing
- Tp缓存规范
- 常见数据缓存
- 缓存设计思考
- Tp日志规范
- 日志信息
- 日志分析
- Tp日志接管分析
- Tp性能优化
- vendor包规范
- 项目自动化思考
- 项目检测告警思考
- 项目注释规范
- Mysql设计规范
- 序言
- 命名规范
- 表及字段规范
- 索引规范
- 索引原理
- Sql规范
- 事务规范
- 读写分离
- 乐观锁悲观锁
- 数据库审计
- 性能优化
- 查询优化神器
- 慢查询优化步骤
- 分库分表、分区表
- 根据sql日志筛选数据
- 设计原则
- MongoDB规范
- MongoDB基础
- MongoDB设计
- MongoDB安全性
- MongoDB备份
- 操作手册规范
- API文档说明规范
- 管理端操作手册
- 用户使用说明书
- 溯源项目构想