华为C语言编程规范总则.pdf资源-CSDN文库

4星 · 超过85%的资源需积分: 10 120 浏览量 2011-12-01 20:57:21 上传评论收藏 85KB PDF 举报

资源推荐

资源详情

资源评论

- 1 -

编程规范总则

编程规范总则 1

1 排版 1

2 注释 3

3 标识符命名 7

4 可读性 9

5 变量、结构 10

6 函数、过程 14

7 程序效率 19

8 质量保证 23

9 代码编辑、编译、审查 28

10 代码测试、维护 29

11 宏 30

1 排版

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;

Generated by Foxit PDF Creator © Foxit Software

http://www.foxitsoftware.com For evaluation only.

- 2 -

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 语句中的程序都要采用如上的缩进方式。

Generated by Foxit PDF Creator © Foxit Software

http://www.foxitsoftware.com For evaluation only.

- 4 -

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

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;

http://www.foxitsoftware.com For evaluation only.

- 5 -

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;

http://www.foxitsoftware.com For evaluation only.

剩余30页未读，继续阅读

评论收藏

内容反馈

guoxze

2013-04-11

很好的学习编程规范的资料！

yi_yuan_1988

粉丝: 1
资源: 9

华为C语言编程规范总则.pdf

华为C语言编程规范总则-pdf

华为C语言编程规范总则

最新华为软件编程规范总则华为软件编程规范总则.

华为技术有限公司c语言编程规范.pdf.zip_C语言规范_pdf_weak9pr_华为 代码规范_华为c语言规范

华为技术有限公司c语言编程规范.pdf

华为C语言编程规范 PDF

华为编程规范总则

C语言编程规范总则

华为编程规范总则（全）

华为公司设计规范软硬件设计规范EMC电磁兼容PCB设计规范等文档资料合集.zip

华为C语言编程规范[汇编].pdf

华为的C语言编程规范.pdf

华为最强软硬件技术资料库电路设计规范资料合集.zip

华为 C语言编程规范 2011版(带书签).pdf

华为软件编程规范总则

华为JAVA编程规范汇编.pdf

华为verilog编程规范.pdf

软件编程规范总则 华为

软件编程规范总则，软件编程规范总则

最新资源

华为技术有限公司c语言编程规范.pdf.zip_C语言规范_pdf_weak9pr_华为代码规范_华为c语言规范

软件编程规范总则华为