一个好的开发规范应该包含哪些内容

简述

开发规范是基于某种特定的开发语言和架构,进行开发的基本原则和推荐方式,在开发过程中有迷惑时进行参照的指南。
开发规范不同于编码规则,但一定要包含编码规则。

好的开发规范应该具有以下几个特征

1、明确书写和阅读的方式

1.1项目名或者是概要
规范中所要描述的项目和规定内容
说明:
关于该项目的说明或者是补充说明
理由:
进行规定的目的、或者想达到什么结果、以及该项目存在的理由。

2、明确工程文件构成

包括工程文件夹和各种类型的代码、资源文件的命名。
还有文件的编码方式(utf还是GB)。

3、编码规范

一般性约束

代码缩进方式
不同类型(私有、公有)函数的顺序
段落指示符(c#的#region 和OC的#pragma mark -)的运用
编码约束
全部变量的使用
变量的作用域:属性、实例变量、区部变量
枚举类型的值类型和初始值设定
函数的提取
去除残留代码和调试时的Log
减少对环境依赖的处理逻辑等

4、注释规范

注释的规范方针
和代码一致性原则
不同场合对不同类型注释(单行、多行、带参数等)的使用规定

5、异常处理

异常的封装
异常的后续处理(用户提示还是Log记录)

6、效率规范

针对不同语言的特点,禁止和提倡哪些用法
资源的使用和释放

7、UI规范

控件的命名
UI布局规范(从左到右从上到下、所属、内外间距等)

总结

好的开发规范不仅仅是明确基本的开发约束,还要提出哪些做法是项目推荐的哪些是做法是要摒弃的。同时还要对这些事项有足够的说明和理由。

开发规范的内容要根据项目中代码评审等发现的问题及时进行整理和补充。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,420评论 25 708
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,967评论 19 139
  • 正 用将来理想的自己作为现在的名号,反复的暗示,是一种通行的激励手段,如果行为能跟进,会促使做成一些事情,但一般都...
    恰恰天蓝阅读 269评论 7 4
  • 素生 黎明听雨迎立秋, 残梦半醒独运筹。 风雨鹏程千万里, 一路思乡一路愁。
    杨共同学阅读 169评论 0 4
  • 长沙最近的气温下降了些,一种开电风扇有些冷,关了又有些热的微妙,让我不禁有些苦恼。幸而床上还有一条温暖的绒毯,让我...
    邪语非道阅读 208评论 0 2