软件开发编码规范说明

2017

软件开发编码规范说明梁峰2017-5-31

一、高级语言 (3)

1.1 适用范围 (3)

1.2 程序风格 (3)

1.2.1. 代码缩进 (3)

1.2.2. 变量申明 (3)

1.2.3. 代码块长度 (3)

1.2.4. 代码换行 (3)

1.2.5. 空行及空格 (4)

1.3 命名 (4)

1.3.1. 变量命名 (4)

1.3.2. 常量命名 (5)

1.3.3. 函数或方法命名 (5)

1.3.4. 文件命名 (6)

1.4 注释 (6)

1.4.1. 代码注释 (6)

1.4.2. 变量注释 (6)

1.4.3. 函数注释 (7)

1.4.4. 文件注释 (7)

1.5 错误和异常处理 (8)

1.5.1. 错误处理 (8)

1.5.2. 异常处理 (8)

1.6 注意事项 (11)

1.6.1. 变量的使用 (11)

1.6.2. 代码实现 (11)

1.7 日志规约 (12)

二、结构化查询语言 (15)

2.1. 程序风格 (15)

2.1.1. SQL语句 (15)

2.1.2. 存储过程 (17)

2.1.3. 存储过程命名 (17)

2.1.4. 变量命名 (17)

2.1.5. 游标命名 (18)

2.1.6. 常量命名 (18)

2.2. 建表规约 (18)

2.1. 安全规约 (20)

2.3. 注释 (22)

2.3.1. 代码注释 (22)

2.3.2. 存储过程注释 (22)

2.3.3. 常量及变量注释 (22)

2.4. 错误和和异常处理 (23)

2.5. 注意事项 (23)

一、高级语言

1.1适用范围

主要针对JSP，CSS和JAVA高级编程语言，其它高级语言可参照执行。

1.2程序风格

1.2.1.代码缩进

程序块（包括函数、过程、结构的定义及循环、判断等语句）要严格采用缩进风格编写，对齐只使用空格键，不使用TAB键，所有的缩进为4个空格。

1.2.2.变量申明

在函数内部申明变量时，必须在函数的开始位置。

1.2.3.代码块长度

单个函数的程序行数不得超过200行。一个程序文件的长度不得超过5000行代码。

1.2.4.代码换行

1.较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作

符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。

2.不允许把多个短语句写在一行中，即一行只允许写一条语句（如if 、

for 、do 、while、case 、switch等语句自占一行）。

3.程序块的分界符必须各自独占一行并且位于同一列，同时与引用它们的

语句左对齐。

1.2.5.空行及空格

1.通过摘要注释分隔的两个代码块之间、局部变量和它后边的语句之间、

函数之间留一个空行。

2.在所有关键字和逗号之后要留一个空格，方法名之后不要留空格，紧跟

左括号“（”，以与关键字区别。

3.如果“;”不是一行的结束符号，其后要留空格，如for (initialization;

condition; update)。

4.赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如

“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”，“^”等二

元操作符的前后要加空格。

5.一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空

格。诸如“［］”、“.”、“->”这类操作符前后不加空格。

1.3命名

1.3.1.变量命名

1.变量的名字须使用“名词”或者“形容词＋名词”。变量的命名要求符合匈

牙利命名法则，即开头字母用变量的类型（第一个字母小写），其余部

分用变量的英文意思或其英文意思的缩写（尽量避免用中文的拼音），

中间单词的第一个字母要大写。即：变量名=变量类型+变量的英文意

思（或缩写）。

2.变量名称须准确、完整地描述变量的含义。循环计数变量的名称须有含

义。如果循环语句的长度超过了两行或者存在着嵌套循环，避免使用i、j或k之类的变量，须使用有意义的变量，有利于程序的理解。（单字

符的变量名一般只用于生命期非常短暂的变量）。

3.对于所有布尔型变量的命名，能够直接从名称上看出为真的条件。枚举

类型的变量名称须包含基础类型，以方便分辨变量的类型。例如，用

Color变量表示ColorRed和ColorGreen枚举类型的值。

4.在所有全局变量前首字母必须使用‘v’，接口指针必须使用“pi”，后跟接

口名称缩写。在申明变量时要避免局部变量与公共变量同名、块内部变

量与它外部变量同名。

1.3.

2.常量命名

常量的命名须代表抽象的实体，而非它们所代表的值，即对于涉及物理状态或者含有物理意义的常量，不允许直接使用不易理解的数字，必须用有意义的枚举或宏来代替。所有常量名均全部大写，由英文或其缩写，单词间以‘_’隔开，如int MAX_NUM。

1.3.3.函数或方法命名

函数或方法的命名应该尽量用英文表达出函数或方法完成的功能。遵循动宾结构的命名法则，函数或方法名中动词在前，类的成员函数或方法须只使用“动词”，第一个字母是小写，但是中间单词的第一个字母是大写。如果是返回