软件编程规范总结.docx

软件编程标准总结
本标准的内容包括：基本原则、布局、注释、命名规则、变量常量与类型、表达式与语句、函数与过程、可靠性、可测性、断言与错误处理等。
基本原则
保持代码的简明清晰，防止过分的编程技巧。
所有的代码尽量遵循ANSI C预编译开关除外〕。
程序中不要出现仅靠大小写区分的相似的标识符。
用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
宏、常量名都要使用大写字母, 用下划线 ‘_’ 分割单词。预编译开关的定义使用下划线 ‘_’ 开始。
变量名长度应小于31个字符，以保持与ANSI C标准一致。不得取单个字符〔如i、j、k等〕作为变量名，但是局部循环变量除外。
程序中局部变量不要与全局变量重名。
使用一致的前缀来区分变量的作用域。
g_ ： 全局变量
s_ ： 模块内静态变量
空 ： 局部变量不加范围前缀
使用一致的小写类型指示符作为前缀来区分变量的类型。
说明：常用变量类型前缀列表如下：
i ： int
f ： float
d ： double
c ： char
uc ： unsigned char 或 BYTE
l ： long
p ： pointer
b ： BOOL
h ： HANDLE
w ： unsigned short 或 WORD
dw ： DWORD或 unsigned long
a ： 数组，array of TYPE
str ： 字符串
t ： 结构类型
完整的变量名应由前缀+变量名主体组成，变量名的主体应当使用“名词”或者“形容词＋名词”，且首字母必须大写。
float g_fValue;
函数名用大写字母开头的单词组合而成，且应当使用“动词”或者“动词＋名词”〔动宾词组〕。
结构名、联合名、枚举名由前缀T_ 开头。事件名由前缀EV_ 开头。
标识符前最好不加项目、产品、部门的标识。
变量常量与类型
定义全局变量时必须仔细分析，明确其含义、作用、取值范围及与其它全局变量间的关系。
明确全局变量与操作此全局变量的函数或过程的关系。
一个变量有且只有一个功能，不能把一个变量用作多种用途。
循环语句与判断语句中，不允许对其它变量进行计算与赋值。
宏定义中如果包含表达式或变量，表达式和变量必须用小括号括起来。
使用宏定义多行语句时, 必须使用 { } 把这些语句括起来。
建议：
尽量构造仅有一个模块或函数可以修改、创建的全局变量，而其余有关模块或函数只能访问。
对于全局变量通过统一的函数访问。
尽量使用const说明常量数据，对于宏定义的常数，必须指出其类型。
最好不要在语句块内声明局部变量。
结构和联合必须被类型化。
typedef struct
{
char acName[NAME_SIZE];
WORD wScore;
} T_Student;
T_Student *ptStudent;
建议：
使用严格形式定义的、可移植的数据类型，尽量不要使用与具体硬件或软件环境关系密切的变量。
结构是针对一种事