软件的运行靠的是代码的主体,软件质量的保障需要的是技术人员的经验和态度,然而现在的软件已经几乎都是“工程”级别的,所以需要的不再是一个几个技术人员,而是一个团队的协作。这样保证完整的代码编程规范,合理的注释就变得尤其重要。
代码规范可以从命名(变量,类,方法等)和注释两个角度来讲。
代码命名的的根本目的是增加代码的辨识度,增强代码可读性方便开发人员之间的交流理解。所以变量,类,方法等命名都应该清楚明了,比如方法应该以动词开头,使用 Pascal 大小写,禁止缩写,除非名词本身含有缩写;接口使用 Pascal 大小写,在原有类名基础上加“I”,如:IUser,不使用下划线( _ )。需要特别注意的是命名一定要使用英文!!!
较常用的命名法有:
Pascal命名法:所有单词的首字母都大写,其他字母小写
Camel命名法:除首字母外,其他单词的首字母大写,其他字母小写
代码的注释是对代码可读性的进一步提高,良好的注释可以大大增加代码的辨识度,注释保持一致性可以更便于开发人员互相了解开发进度,调用对应内容直接观察注释即可,省去不必要交流,所以注释也应该保持一直的规范。比如:对于自己创建的代码文件(如函数、脚本),在文件开头说明作者,小组,说明,创建日期,版本号等信息;在模块、类、属性、方法前一行添加注释,以便调用的时候提示用户;使用语句块时必须添加注释(if,for,foreach,……),注释必须能够说明此语句块的作用和实现手段。
总结一下:代码规范可以减少即使问题的发生,可以方便代码的查错工作(统一规范,有据可循),提升团队的合作能力,从而减少维护带来的成本。