1 背景概述
作为程序员大军中的一员,笔者工作于沈阳数通畅联软件技术有限公司。在任职工作的第一天就听领导强调开发规范的重要性,但是笔者心里还想为什么开发规范是最重要的,难道是不应该是实现功能就万事大吉了?
随着时间的推移,笔者也经历了几个软件项目,越来越意识到开发规范的重要。今天笔者将自己的所听、所学以及个人的总结汇总出来与大家分享,希望可以为大家提供帮助。
2 目的意义
在团队协作开发的情况下,一套鲜明的编程风格,可以让协作者、后继者和自己一目了然,在很短的时间内看清程序的结构,理解设计的思路。提高代码的可读性、可重用性、程序健壮性、可移植性和可维护性。制定开发规范的目的是为了提高软件开发效率及所开发的软件的可维护性,提高软件的质量。通过开发规范的约束提升自身的逻辑思维能力,也侧面的提升个人编码能力及水平。
3 开发规范
作为软件项目的开发人员而言,对于功能代码,首要的要求是代码必须正确的,能够保证功能是可运行的,并且能够满足客户的需求。第二个的要求是代码必须清晰易懂,方便于其他的程序员能够容易理解代码的原理,增强代码的可读性,保证代码统一一致的编程风格。下面我们通过格式、命名、权限、性能等几个方面来明确开发规范。
3.1 统一格式
- 整体风格
- 采用阶梯层次组织程序代码。每层次缩进为4格,括号位于下一行。要求相匹配的大括号在同一列,对下一行同样要再缩进4格。参考代码如下:
- 对变量的定义,尽量位于函数的开始位置,对于全局变量/静态变量要定义与类名与构造函数之间。
- 空格表示分割,用一个空格运算符两边用一个空格隔开。如a + b = c,不能a+b=c;如果逗号语句后不还行,则需要在逗号后紧跟一个空格如:call(a, b, c);不能call(a,b,c)。