为什么
首先说为什么要规范代码,至少可以归结于以下几点:
- 可以提高代码的可读性
- 时间久了自己再维护的时候可以一眼看懂语句的含义
- 便于后者来看懂并理解你的代码
注释规范
1、对于自己创建的代码文件,在文件开头,一般编写如下注释:
/*************************************************
作者:
小组:
说明:
创建日期:
版本号:
**********************************************/
2、在模块、类、属性、方法前一行添加注释,以便调用的时候提示用户,对于重构的类文件,需要对原来的类文件做备份,然后放在同级目录下,在原有文件名后面添加后缀"_BAK",以便日后版本升级时整理源码。
3、代码间注释分为单行注释和多行注释:
单行注释:
//<单行注释>
多行注释:
/*多行注释1
多行注释2
多行注释3*/
代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明此语句块的作用和实现手段(所用算法、循环条件、不同分支的意义等等)。
命名规则
- 名字能够标识事物的特性,并且与业务挂钩。
- 名字一律使用英文单词,而不能为拼音。
- 名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内。
- 在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。
- 不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用 GetWindow,而不要使用 GetWin。
- 不要使用计算机领域中未被普遍接受的缩写。
-
在适当的时候,使用众所周知的缩写替换冗长的词组名称。
版本管理规则
当源码包初版时,版本号为 V1.00;被局部修改或bug修正时,发行号不变,修改号第二个数字增1。例如,对初版源码包作了第一次修订,则版本号为 V1.01;当源码包在原有的基础上增加部分功能,发行号不变,修改号第一个数字增1,例如,对V1.12版的基础上增加部分功能,则新版本号为 V1.20;有重要修改或局部修订累积较多导致源码包发生全局变化时,发行号增1。例如,在 V1.15 版的基础上作了一次全面修改,则新版本号为 V2.00。
数据库命名规则
数据库命名采用首字母大写,避免用系统的表名,数据库表使用T_表名,表名首字母应大写,如果系统分多个子系统模块,那么将模块的缩写加在T后,用下划线与表名分开。
我们要时刻要求自己,养成良好的代码习惯,向优秀程序员靠拢。