c代码规范（参考）

1、排版

1.1 程序块要采用缩进风格编写，缩进的空格数为4个，不应采用TAB键进行缩进。

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)

 

1.4 循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

示例：

if ((taskno < max_act_task_number)

    && (n7stat_stat_item_valid (stat_item)))

{

    ... // program code

}

 

for (i = 0, j = 0; (i < BufferKeyword[word_index].word_length)

                    && (j < NewKeyword.word_length); i++, j++)

{

    ... // program code

}

 

for (i = 0, j = 0;  

     (i < first_word_length) && (j < second_word_length);  

     i++, j++)

{

    ... // program code 

}

 

1.5 若函数或过程中的参数较长，则要进行适当的划分。

示例：

n7stat_str_compare((BYTE *) & stat_object,

                   (BYTE *) & (act_task_table[taskno].stat_object),

                   sizeof (_STAT_OBJECT));

 

n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER

                                      + index, stat_object );

1.6 不允许把多个短语句写在一行中，即一行只写一条语句。

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

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

 

应如下书写

rect.length = 0;

rect.width  = 0;

 

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

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

if (pUserCR == NULL) return;

 

for

 

应如下书写：

if (pUserCR == NULL)

{

    return;

}

 

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

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

for (...) {

    ... // program code

}

 

if (...) 

    {

    ... // program code

    }

 

void example_fun( void )

    {

    ... // program code

}

 

switch(var)

{

case 1:

{

break;

 }

 

default:

break;

}

 

应如下书写。

for (...) 

{

    ... // program code

}

 

if (...) 

{

    ... // program code

}

 

void example_fun( void )

{

    ... // program code

}

 

switch(var)

{

case 1:

{

break;

}

default:

{

Break;

}

}

 

1.9 在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。

说明：采用这种松散方式编写代码的目的是使代码更加清晰。

由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C++语言中括号已经是最清晰的标志了。

在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

 

示例：

(1) 逗号、分号只在后面加空格。

int a, b, c; 

 

(2)比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。

if (current_time >= MAX_TIME_VALUE) 

a = b + c;

a *= 2;

a = b ^ 2;

 

(3)"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。

*p = 'a';        // 内容操作"*"与内容之间

flag = !isEmpty; // 非操作"!"与内容之间

p = &mem;        // 地址操作"&" 与内容之间

i++;             // "++","--"与内容之间

 

(4)"->"、"."前后不加空格。

p->id = pid;     // "->"指针前后不加空格

 

(5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。

if (a >= b && c > d)

 

2、注释

2.1 源文件头部应进行注释，列出：版权说明、文件名、模块名、文件的目的和功能、修改的目期、作者、修改日志等。

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

* (C) Copyright [2012-2022] HOJY Wireless Ltd. All Rights Reserved.   

* 

* File Name : gui_main.c

*

* Module : mifi-ui 

*

* Description:  mifi-ui module

*  

* History :( Date | Author | Description ) 

* 12.12.28 | pengeh |v1.0 delivery based on mdm9215 platform.

* 

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

 

2.2 函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值等。

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

Function Name:  main

InitInput Parameters: void

Output Parameters: void

Return Code:  void

Description:  main function

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

 

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

 

2.4 注释的内容要清楚、明了，含义准确，防止注释二义性。

说明：错误的注释不但无益反而有害。

 

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

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

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

示例：

/* active statistic task number */

#define MAX_ACT_TASK_NUMBER 1000

 

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

 

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

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

/* 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.8 全局变量要有较详细的注释，包括对其功能、取值范围、存取时注意事项等的说明。

示例：

/* The ErrorCode when SCCP translate */

/* Global Title failure, as follows */      // 变量作用、含义

/* 0 － SUCCESS   1 － GT Table error */

/* 2 － GT error  Others － no use  */       // 变量取值范围

/* module can visit it through call */

int g_error_code;  

 

2.9 注释与所描述内容进行同样的缩排。

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

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

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.10 将注释与其上面的代码用空行隔开。

示例：如下例子，显得代码过于紧凑。

/* code one comments */

program code one

/* code two comments */

program code two

 

应如下书写

/* code one comments */

program code one

 

/* code two comments */

program code two

 

2.11 避免在一行代码或表达式的中间插入注释。

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

 

2.12 注释格式尽量统一，建议使用“/* …… */”

说明：此规则为建议性，以代码理解性和可阅读性为原则。

 

2.13 注释应考虑程序易读及外观排版的因素，请使用英文进行注释。

说明：注释语言不统一，影响程序易读性和外观排版，出于中文注释因编码不同产生乱码问题，建议使用英文。

 

3、命名

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

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

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

temp 可缩写为  tmp  ;

flag 可缩写为  flg  ;

statistic 可缩写为  stat ;

increment 可缩写为  inc  ;

message 可缩写为  msg  ;

result 可缩写为 ret ;

error 可缩写为 err ;

buffer 可缩写为 buff ;

 

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

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

 

3.3 命名长度以小于64字符为最佳，如果以下划线连接，以小于5段为最佳。

 

3.4 对于变量命名，禁止取单个字符（如i、j、k...）。

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

 

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

示例：

在类UNIX系统下

AddUser addUser Add_User 都不合法

add_user m_add_user g_add_user合法

 

在Windows系统下

add_user Add_User 都不合法

AddUser nAddUser m_AddUser g_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 在一个项目中，为保持一致，模块名和文件名都用小写字母，采用表现模块和文件中心功能的单词和词组。

 

4、变量、结构体和函数

4.1去掉没必要的公共变量。

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

 

4.2 严禁使用未经初始化的变量作为右值。

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

 

4.3 结构的功能要单一，是针对一种事务的抽象。

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

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

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;

 

4.4 不同结构间的关系不要过于复杂。

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

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

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;

 

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

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

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

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;

 

4.6 函数内部变量申明放在函数的开头，并初始化，禁止在函数中进行变量申明。

  说明：避免某些编译器不支持函数中时行变量申明，且容易造变量未经申明就使用。

  示例：如下申明不符合规范

void sum_data( unsigned int num, int *data, int *sum )

{

program code

   int sum_result = 0;

program code

}

 

若改为如下，则更好些。

void sum_data( unsigned int num, int *data, int *sum )

{

int sum_result = 0;

program code

}

 

4.7 对所调用函数的错误返回码要仔细、全面地处理。

 

4.8 避免设计多参数函数，参数以少于5个为最佳，不使用的参数从接口中去掉。

说明：目的减少函数间接口的复杂度。

 

4.9 函数的规模尽量限制在200行以内。

说明：不包括注释和空格行。

 

4.10防止将函数的参数作为工作变量。

说明：将函数的参数作为工作变量，有可能错误地改变参数内容，所以很危险。对必须改变的参数，最好先用局部变量代之，最后再将该局部变量的内容赋给该参数。

示例：下函数的实现不太好。

void sum_data( unsigned int num, int *data, int *sum )

{

    unsigned int count;

    

    *sum = 0;

    for (count = 0; count < num; count++)

    {

        *sum  += data[count]; // sum成了工作变量，不太好。

    }

}

 

若改为如下，则更好些。

void sum_data( unsigned int num, int *data, int *sum )

{

    unsigned int count ;

    int sum_temp;

    

    sum_temp = 0;

    for (count = 0; count < num; count ++)

    {

        sum_temp  += data[count]; 

    }

    

    *sum = sum_temp;

}

 

4.11 检查函数所有参数输入的有效性, 检查函数所有非参数输入的有效性，如数据文件、公共变量等。

说明：对于函数的参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患；要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。为此我们规定都在被调用者做参数检查，同时对公共变量和数据文件等非参数输入也做有效性检查。

 

4.12 在同一项目组或产品组内，调测打印出的信息串的格式要有统一的形式。信息串中至少要有所在模块名（或源文件名）及行号。

说明：统一的调测信息格式便于集成测试。

 

4.13 包含头文件都应该在文件头一起包含，不能在函数内部或文件中间包含相关头文件。

示例：下列头文件包含不好。

示例1 在函数内部包含头文件

void print_buff(void)

{    

#include <stdio.h>

    Printf(“print hello world\n”);

}

 

示例2 在文件中间包含头文件

#include <stdio.h>

 

program code

#include “test.h”

 

program code

 

4.14 用宏定义表达式时，要使用完备的括号。

示例：如下定义的宏都存在一定的风险。

#define RECTANGLE_AREA( a, b ) a * b

#define RECTANGLE_AREA( a, b ) (a * b)

#define RECTANGLE_AREA( a, b ) (a) * (b)

正确的定义应为：

#define RECTANGLE_AREA( a, b ) ((a) * (b))

 

4.15 用宏定义表达式时，要使用完备的括号。

示例：如下用法可能导致错误。

#define SQUARE( a ) ((a) * (a))

 

int a = 5;

int b;

b = SQUARE( a++ ); // 结果：a = 7，即执行了两次增1。

 

正确的用法是：

b = SQUARE( a );

a++; // 结果：a = 6，即只执行了一次增1。

 

5、可读性

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

 

5.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

}

 

5.3 源程序中关系较为紧密的代码应尽可能相邻。

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

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

rect.length = 10;

char_poi = str;

rect.width = 5;

 

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

rect.length = 10;

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

char_poi = str;

 

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

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

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

* stat_poi ++ += 1;

 

* ++ stat_poi += 1;

 

应分别改为如下。

*stat_poi += 1;

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

 

++ stat_poi;

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