变量、结构.doc

编码规范 (变量、结构篇) ―― RD2 -1- 变量、结构 1 :去掉没必要的全局变量和局部变量。说明:全局变量是增大模块间耦合的原因之一,故应减少没必要的全局变量以降低模块间的耦合度。 2 :仔细定义并明确全局变量的含义、作用、取值范围及全局变量间的关系。说明:在对变量声明的同时,应对其含义、作用及取值范围进行注释说明, 同时若有必要还应说明与其它变量的关系。 3 :明确全局变量与操作此全局变量的函数或过程的关系,如访问、修改及创建等。说明:明确过程操作变量的关系后,将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。这种关系的说明可在注释或文档中描述。 RELATION System_Init Input_Rec Print_Rec Stat_Score Student Create Modify Access Access Score Create Modify Access Access, Modify 注: RELATION 为操作关系; System_Init 、 Input_Rec 、 Print_Rec 、 Stat_Score 为四个不同的函数; Student 、 Score 为两个全局变量; Create 表示创建, Modify 表示修改, Access 表示访问。其中, 函数 Input_Rec 、 Stat_Score 都可修改变量 Score , 故此变量将引起函数间较大的耦合, 并可能增加代码测试、维护的难度。 4 :当向全局变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。说明:对全局变量赋值时,若有必要应进行合法性检查,以提高代码的可靠性、稳定性。 5 :防止局部变量与全局变量同名。说明:若使用了较好的命名规则,那么此问题可自动消除。 6 :严禁使用未经初始化的变量作为右值。说明:特别是在 C/C++ 中引用未经赋值的指针,经常会引起系统崩溃。编码规范 (变量、结构篇) ―― RD2 -2- 7 :构造仅有一个模块或函数可以修改、创建,而其余有关模块或函数只访问的全局变量,防止多个不同模块或函数都可以修改、创建同一全局变量的现象。说明:降低全局变量耦合度。 8 :结构的功能要单一,是针对一种事务的抽象。说明:设计结构时应力争使结构代表一种现实事务的抽象,而不是同时代表多种。结构中的各元素应代表同一事务的不同侧面,而不应把描述没有关系或关系很弱的不同事务的元素放到同一结构中。示例:如下结构不太清晰、合理。 typedef struct STUDENT_STRU { unsigned char name[8]; /* student's name */ unsigned char age; /* student's age */ unsigned char sex; /* student's sex, as follows */ /* 0- FEMALE; 1- MALE */ unsigned char teacher_name[8]; /* the student teacher's name */ unisgned char teacher_sex; /* his teacher sex */ } STUDENT; 若改为如下,可能更合理些。 typedef struct