华为C语言编程规范（上）_华为变量命名规则

目录

一、排版

二、注释

三、标识符命名

四、可读性

五、变量、结构

一、排版

1-1：程序块要采用缩进风格编写，缩进的空格数为 4 个。

说明：对于由开发工具自动生成的代码可以有不一致。

1-2：相对独立的程序块之间、变量说明之后必须加空行。

示例：如下例子不符合规范。

if (!valid_ni(ni)) 
{ 
 ... // program code 
} 
repssn_ind = ssn_data[index].repssn_index; 
repssn_ni = ssn_data[index].ni; 

应如下书写

if (!valid_ni(ni)) 
{ 
 ... // program code 
} 
 
repssn_ind = ssn_data[index].repssn_index; 
repssn_ni = ssn_data[index].ni;

1-3：较长的语句（>80 字符）要分成多行书写，长表达式要在低优先级操作符处划分新行， 操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例：

perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN 
 						+ STAT_SIZE_PER_FRAM * sizeof( _UL ); 
act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied 
 			= stat_poi[index].occupied; 
act_task_table[taskno].duration_true_or_false 
 				= SYS_get_sccp_statistic_state( stat_item ); 
report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER) 
 				&& (n7stat_stat_item_valid (stat_item)) 
                && (act_task_table[taskno].result_data != 0));

1-4：不允许把多个短语句写在一行中，即一行只写一条语句。

示例：如下例子不符合规范。

rect.length = 0; rect.width = 0;

应如下书写：

rect.length = 0;
 
rect.width = 0;

1-5：if、for、do、while、case、switch、default 等语句自占一行，且 if、for、do、while 等语句的执行语句部分无论多少都要加括号{}。

示例：如下例子不符合规范。

if (pUserCR == NULL) return;

应如下书写：

 if (pUserCR == NULL) { return; }

1-6：对齐只使用空格键，不使用 TAB 键。

说明：以免用不同的编辑器阅读程序时，因 TAB 键所设置的空格数目不同而造成程序布局 不整齐，不要使用 BC 作为编辑器合版本，因为 BC 会自动将 8 个空格变为一个 TAB 键， 因此使用 BC 合入的版本大多会将缩进变乱。

1-7：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求。

1-8：程序块的分界符（如 C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列， 同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以 及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方式。

示例：如下例子不符合规范。

for (...) { 
 ... // program code 
} 
if (...) 
     { 
     ... // program code 
     } 
void example_fun( void ) 
     { 
     ... // program code 
     }

应如下书写：

for (...) 
{ 
 ... // program code 
} 
if (...) 
{ 
 ... // program code 
} 
void example_fun( void ) 
{ 
 ... // program code 
}

1-9：一行程序以小于 80 字符为宜，不要写得过长。

二、注释

2-1：一般情况下，源程序有效注释量必须在 20％以上。 说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能 太少，注释语言必须准确、易懂、简洁。

2-2：文件头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、 功能、修改日志等。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包 含在内。

/*****************************************************************************

Copyright: 1988-1999, Huawei Tech. Co., Ltd.

File name: 文件名

Description: 用于详细说明此程序文件完成的主要功能，与其他模块或函数的接口，输出 值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系

Author: 作者

Version: 版本

Date: 完成日期

History: 修 改 历 史 记 录 列 表 ， 每 条 修 改 记 录 应 包 括 修 改 日 期 、 修 改 者及修改内容简述。

*****************************************************************************/

2-3：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用 关系（函数、表）等。

示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在 内。

/*************************************************

Function: // 函数名称

Description: // 函数功能、性能等的描述

Calls: // 被本函数调用的函数清单

Called By: // 调用本函数的函数清单

Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）

Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）

Input: // 输入参数说明，包括每个参数的作 // 用、取值说明及参数间关系。

Output: // 对输出参数的说明。

Return: // 函数返回值的说明

Others: // 其它说明

*************************************************/

2-4：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再 有用的注释要删除。

2-5：注释的内容要清楚、明了，含义准确，防止注释二义性。 说明：错误的注释不但无益反而有害。

2-6：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释） 相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。

示例：如下例子不符合规范。

例 1：

/* get replicate sub system index and net indicator */ 
 
 
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni; 

例2：

repssn_ind = ssn_data[index].repssn_index; 
repssn_ni = ssn_data[index].ni; 
/* get replicate sub system index and net indicator */

应如下书写：

/* get replicate sub system index and net indicator */ 
repssn_ind = ssn_data[index].repssn_index; 
repssn_ni = ssn_data[index].ni; 

2-7：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须 加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

示例：

/* active statistic task number */ 
#define MAX_ACT_TASK_NUMBER 1000 
#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */

2-8：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须 加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域 的注释放在此域的右方。

示例：可按如下形式说明枚举/数据/联合结构。

/* sccp interface with sccp user primitive message name */ 
enum SCCP_USER_PRIMITIVE 
{ 
     N_UNITDATA_IND, /* sccp notify sccp user unit data come */ 
     N_NOTICE_IND, /* sccp notify user the No.7 network can not */ 
                     /* transmission this message */ 
     N_UNITDATA_REQ, /* sccp user's unit data transmission request*/ 
};

2-9：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及 存取时注意事项等的说明。

示例：

/* The ErrorCode when SCCP translate */ 
/* Global Title failure, as follows */ // 变量作用、含义
/* 0 － SUCCESS 1 － GT Table error */ 
/* 2 － GT error Others － no use */ // 变量取值范围
/* only function SCCPTranslate() in */ 
/* this modual can modify it, and other */ 
/* module can visit it through call */ 
/* the function GetGTTransErrorCode() */ // 使用方法
BYTE g_GTTranErrorCode;

2-10：注释与所描述内容进行同样的缩排。

说明：可使程序排版整齐，并方便注释的阅读与理解。

示例：如下例子，排版不整齐，阅读稍感不方便。

void example_fun( void ) 
{ 
/* code one comments */ 
 CodeBlock One 
 /* code two comments */ 
 CodeBlock Two 
} 

应改为如下布局：

void example_fun( void ) 
{ 
     /* code one comments */ 
     CodeBlock One 
     /* code two comments */ 
     CodeBlock Two 
}

2-11：避免在一行代码或表达式的中间插入注释。

说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。

2-12：通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成 为自注释的。

说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。

2-13：在代码的功能、意图层次上进行注释，提供有用、额外的信息。

说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者 理解代码，防止没必要的重复注释信息。

示例：如下注释意义不大。

/* if receive_flag is TRUE */

if (receive_flag)

而如下的注释则给出了额外有用的信息。

/* if mtp receive a message from links */

if (receive_flag)

2-14：在程序块的结束行右方加注释标记，以表明某程序块的结束。 说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。

示例：参见如下例子。

if (...) 
{ 
     // program code 
 
     while (index < MAX_INDEX) 
     { 
         // program code 
     } /* end of while (index < MAX_INDEX) */ // 指明该条 while 语句结束
} /* end of if (...)*/ // 指明是哪条 if 语句结束

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

2-16：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用 中文，除非能用非常流利准确的英文表达。

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

三、标识符命名

3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解 的缩写，避免使人产生误解。

说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩 写；一些单词有大家公认的缩写。

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

temp 可缩写为 tmp ; flag 可缩写为 flg ; statistic 可缩写为 stat ; increment 可缩写为 inc ; message 可缩写为 msg ;

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

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

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

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

3-4：对于变量命名，禁止取单个字符（如 i、j、k...），建议除了要有具体含义外，还能表 明其变量类型、数据类型等，但 i、j、k 作局部循环变量是允许的。

说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如 i 写成 j），而编译时 又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。

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

int liv_Width 其变量名解释如下：

        l 局部变量（Local） （其它：g 全局变量（Global）...）

        i 数据类型（Interger）

        v 变量（Variable） （其它：c 常量（Const）...）

        Width 变量含义

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

3-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用 UNIX 的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用 作特殊标识如标识成员变量或全局变量的 m_和 g_，其后加上大小写混排的方式是允许的。

示例： Add_User 不允许，add_user、AddUser、m_AddUser 允许。

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

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

#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-7：在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名， 防止编译、链接时产生冲突。

说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量 之前加上“模块”标识等。

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

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

示例：

int min_sum; int max_sum;

int add_user( BYTE *user_name ); int delete_user( BYTE *user_name );

3-9：除了编译开关/头文件等特殊应用，应避免使用_EXAMPLE_TEST_之类以下划线开始 和结尾的定义。

四、可读性

4-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)造成了判断条件出错。

4-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-3：源程序中关系较为紧密的代码应尽可能相邻。

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

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

rect.length = 10;

char_poi = str;

rect.width = 5;

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

rect.length = 10;

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

char_poi = str;

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

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

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

* stat_poi ++ += 1; * ++ stat_poi += 1;

应分别改为如下。

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

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

五、变量、结构

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

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

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

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

5-3：明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。

说明：明确过程操作变量的关系后，将有利于程序的进一步优化、单元测试、系统联调以及 代码维护等。这种关系的说明可在注释或文档中描述。

示例：在源文件中，可按如下注释形式说明。

注：RELATION 为操作关系；System_Init、Input_Rec、Print_Rec、Stat_Score 为四个不同的函数；Student、Score为两个全局变量；Create 表示创建，Modify 表示修改，Access 表示访问。

其中，函数 Input_Rec、Stat_Score 都可修改变量 Score，故此变量将引起函数间较大的耦合， 并可能增加代码测试、维护的难度。

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

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

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

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

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

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

5-7：结构的功能要单一，是针对一种事务的抽象。

说明：设计结构时应力争使结构代表一种现实事务的抽象，而不是同时代表多种。结构中的 各元素应代表同一事务的不同侧面，而不应把描述没有关系或关系很弱的不同事务的元素放 到同一结构中。

示例：如下结构不太清晰、合理。

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 TEACHER_STRU 
{ 
 unsigned char name[8]; /* teacher name */ 
 unisgned char sex; /* teacher sex, as follows */ 
 /* 0 - FEMALE; 1 - MALE */ 
} TEACHER; 
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 int teacher_ind; /* his teacher index */ 
} STUDENT

5-8：不要设计面面俱到、非常灵活的数据结构。

说明：面面俱到、灵活的数据结构反而容易引起误解和操作困难。

5-9：不同结构间的关系不要过于复杂。

说明：若两个结构间关系较复杂、密切，那么应合为一个结构。

示例：如下两个结构的构造不合理。

typedef struct PERSON_ONE_STRU 
{ 
 unsigned char name[8]; 
 unsigned char addr[40]; 
 unsigned char sex; 
 unsigned char city[15]; 
} PERSON_ONE; 
typedef struct PERSON_TWO_STRU 
{ 
 unsigned char name[8]; 
 unsigned char age; 
 unsigned char tel; 
} PERSON_TWO; 

由于两个结构都是描述同一事物的，那么不如合成一个结构。

typedef struct PERSON_STRU 
{ 
 unsigned char name[8]; 
 unsigned char age; 
 unsigned char sex; 
 unsigned char addr[40]; 
 unsigned char city[15]; 
 unsigned char tel; 
} PERSON;

5-10：结构中元素的个数应适中。若结构中元素个数过多可考虑依据某种原则把元素组成不 同的子结构，以减少原结构中元素的个数。

说明：增加结构的可理解性、可操作性和可维护性。

示例：假如认为如上的_PERSON 结构元素过多，那么可如下对之划分。

typedef struct PERSON_BASE_INFO_STRU 
{ 
 unsigned char name[8]; 
 unsigned char age; 
 unsigned char sex; 
} PERSON_BASE_INFO; 
typedef struct PERSON_ADDRESS_STRU 
{ 
 unsigned char addr[40]; 
 unsigned char city[15]; 
 unsigned char tel; 
} PERSON_ADDRESS; 
typedef struct PERSON_STRU 
{ 
 PERSON_BASE_INFO person_base; 
 PERSON_ADDRESS person_addr; 
} PERSON; 

5-11：仔细设计结构中元素的布局与排列顺序，使结构容易理解、节省占用空间，并减少引 起误用现象。

说明：合理排列结构中元素顺序，可节省空间并增加可理解性。

示例：如下结构中的位域排列，将占较大空间，可读性也稍差。

typedef struct EXAMPLE_STRU 
{ 
     unsigned int valid: 1; 
     PERSON person; 
     unsigned int set_flg: 1; 
} EXAMPLE; 

若改成如下形式，不仅可节省 1 字节空间，可读性也变好了。

typedef struct EXAMPLE_STRU 
{ 
     unsigned int valid: 1; 
     unsigned int set_flg: 1; 
     PERSON person ; 
} EXAMPLE;

5-12：编程时，要注意数据类型的强制转换。

说明：当进行数据类型强制转换时，其数据的意义、转换后的取值等都有可能发生变化，而 这些细节若考虑不周，就很有可能留下隐患。

5-13：对编译系统默认的数据类型转换，也要有充分的认识。

示例：如下赋值，多数编译器不产生告警，但值的含义还是稍有变化。

char chr;

unsigned short int exam;

chr = -1;

exam = chr; // 编译器不产生告警，此时 exam 为 0xFFFF。

5-14：尽量减少没有必要的数据类型默认转换与强制转换。

5-15：合理地设计数据并使用自定义数据类型，避免数据间进行不必要的类型转换。

5-16：对自定义数据类型进行恰当命名，使它成为自描述性的，以提高代码可读性。注意其 命名方式在同一产品中的统一。

说明：使用自定义类型，可以弥补编程语言提供类型少、信息量不足的缺点，并能使程序清 晰、简洁。

示例：可参考如下方式声明自定义数据类型。

下面的声明可使数据类型的使用简洁、明了。

typedef unsigned char BYTE; 
typedef unsigned short WORD; 
typedef unsigned int DWORD;

下面的声明可使数据类型具有更丰富的含义。

typedef float DISTANCE; 
typedef float SCORE; 

华为C语言编程规范总则（下）-CSDN博客