sage from links */

if (receive_flag)

.2-4：在程序块的结束行右方加注释标记，以表明某程序块的结束。

说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。

示例：参见如下例子。

if (...)

{

// program code

while (index < max_index)

{

// program code

} /* end of while (index < max_index) */ // 指明该条while语句结

束

} /* end of if (...)*/ // 指明是哪条if语句结束

.2-5：注释格式尽量统一，建议使用“/* …… */”。

.2-6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中

文，除非能用非常流利准确的英文表达。

说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用

中文。

3 标识符命名

13-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的

缩写，避免使人产生误解。

说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成

缩写；一些单词有大家公认的缩写。

示例：如下单词的缩写能够被大家基本认可。

temp 可缩写为 tmp ;

flag 可缩写为 flg ;

statistic 可缩写为 stat ;

increment 可缩写为 inc ;

message 可缩写为 msg ;

13-2：命名中若使用特殊约定或缩写，则要有注释说明。

说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进

行必要的注释说明。

13-3：自己特有的命名风格，要自始至终保持一致，不可来回变化。

说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即

命名规则中没有规定到的地方才可有个人命名风格）。

13-4：对于变量命名，禁止取单个字符（如i、j、k...），建议除了要有具体含义外，还能

表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。

说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编

译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。

示例：下面所示的局部变量名的定义方法可以借鉴。

int liv_width

其变量名解释如下：

l 局部变量（local） （其它：g 全局变量（global）...）

i 数据类型（interger）

v 变量（variable） （其它：c 常量（const）...）

width 变量含义

这样可以防止局部变量与全局变量重名。

13-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用unix的

全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用作特殊

标识如标识成员变量或全局变量的m_和g_，其后加上大小写混排的方式是允许的。

示例： add_user不允许，add_user、adduser、m_adduser允许。

.3-1：除非必要，不要用数字或较奇怪的字符来定义标识符。

示例：如下命名，使人产生疑惑。

#define _example_0_test_

#define _example_1_test_

void set_sls00( byte sls );

应改为有意义的单词命名

#define _example_unit_test_

#define _example_assert_test_

void set_udt_msg_sls( byte sls );

.3-2：在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防

止编译、链接时产生冲突。

说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常

量之前加上“模块”标识等。

.3-3：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

说明：下面是一些在软件中常用的反义词组。

add / remove begin / end create / destroy

insert / delete first / last get / release

increment / decrement put / get

add / delete lock / unlock open / close

min / max old / new start / stop

next / previous source / target show / hide

send / receive source / destination

cut / paste up / down

示例：

int min_sum;

int max_sum;

int add_user( byte *user_name );

int delete_user( byte *user_name );

.3-4：除了编译开关/头文件等特殊应用，应避免使用_example_test_之类以下划线开始和

结尾的定义。

4 可读性

14-1：注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。

说明：防止阅读程序时产生误解，防止因默认的优先级与设计思想不符而导致程序出错。

示例：下列语句中的表达式

word = (high << 8) | low (1)

if ((a | b) && (a & c)) (2)

if ((a | b) < (c & d)) (3)

如果书写为

high << 8 | low

a | b && a & c

a | b < c & d

由于

high << 8 | low = ( high << 8) | low,

a | b && a & c = (a | b) && (a & c)，

(1)(2)不会出错，但语句不易理解；

a | b < c & d = a | （b < c） & d，(3)造成了判断条件出错。

14-2：避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的

常量，不应直接使用数字，必须用有意义的枚举或宏来代替。

示例：如下的程序可读性差。

if (trunk[index].trunk_state == 0)

{

trunk[index].trunk_state = 1;

... // program code

}

应改为如下形式。

#define trunk_idle 0

#define trunk_busy 1

if (trunk[index].trunk_state == trunk_idle)

{

trunk[index].trunk_state = trunk_busy;

... // program code

}

.4-1：源程序中关系较为紧密的代码应尽可能相邻。

说明：便于程序阅读和查找。

示例：以下代码布局不太合理。

rect.length = 10;

char_poi = str;

rect.width = 5;

若按如下形式书写，可能更清晰一些。

rect.length = 10;

rect.width = 5; // 矩形的长与宽关系较密切，放在一起。

char_poi = str;

.4-2：不要使用难懂的技巧性很高的语句，除非很有必要时。

说明：高技巧语句不等于高效率的程序，实际上程序的效率关键在于算法。

示例：如下表达式，考虑不周就可能出问题，也较难理解。

* stat_poi ++ += 1;

* ++ stat_poi += 1;

应分别改为如下。

*stat_poi += 1;

stat_poi++; // 此二语句功能相当于“ * stat_poi ++ += 1; ”

++ stat_poi;

*stat_poi += 1; // 此二语句功能相当于“ * ++ stat_poi += 1; ”

5 变量、结构

15-1：去掉没必要的公共变量。

说明：公共变量是增大模块间耦合的原因之一，故应减少没必要的公共变量以降低模块间

的耦合度。

15-2：仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。

说明：在对变量声明的同时，应对其含义、作用及取值范围进行注释说明，同时若有必要

还应说明与其它变量的关系。

15-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，故此变量将引起函数间较

大的耦合，并可能增加代码测试、维护的难度。

15-4：当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。

说明：对公共变量赋值时，若有必要应进行合法性检查，以提高代码的可靠性、稳定性。

15-5：防止局部变量与公共变量同名。

说明：若使用了较好的命名规则，那么此问题可自动消除。

15-6：严禁使用未经初始化的变量作为右值。

说明：特别是在c/c++中引用未经赋值的指针，经常会引起系统崩溃。

.5-1：构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共变量，

防止多个不同模块或函数都可以修改、创建同一公共变量的现象。

说明：降低公共变量耦合度。

.5-2：使用严格形式定义的、可移植的数据类型，尽量不要使用与具体硬件或软件环境关系密

切的变量。

说明：使