2 C语言编程规范总则0608

C语言编程的一些规范

编程规范总则

编程规范总则

1 排版 2 注释

3 标识符命名 4 可读性 5 变量、结构 6 函数、过程 7 程序效率 8 质量保证

9 代码编辑、编译、审查10 代码测试、维护 11 宏

1 1 3 7 9 10 14 19 23 28 29 30

C语言编程的一些规范

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;

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;

C语言编程的一些规范

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 }

C语言编程的一些规范

应如下书写。 for (...) {

... // program code }

if (...) {

... // program code }

void example_fun( void ) {

... // program code }

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

C语言编程的一些规范

2 注释

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：边写代码边注释，修改代 …… 此处隐藏：10323字，全部文档内容请下载后查看。喜欢就下载吧 ……