代码规范

代码规范

1. 目的 ............................................................................................................ 2 2. 排版 ............................................................................................................ 2 3. 注释 ............................................................................................................ 7 4. 标识符命名 .............................................................................................. 12 5. 可读性 ...................................................................................................... 14 6. 函数、过程 .............................................................................................. 17

1. 目的

本章主要介绍编程规范，编程规范对于程序开发人员来说非常重要，尤其是初学者，这可以使初学者一开始便建立一个良好的编程习惯。这样的习惯有利于提高代码的可读性与可维护性。

2. 排版

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

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

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;

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));

4. 循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达

式要在低优先级操作符处划分新行，操作符放在新行之首。

示例：

if ((taskno < max_act_task_number)

&& (n7stat_stat_item_valid (stat_item))) {

... // program code }

for (i = 0, j = 0;

(i < first_word_length) && (j < second_word_length); i++, j++) {

... // program code }

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

示例：

n7stat_str_compare((BYTE *) & stat_object,

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

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

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

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

应如下书写

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

7. if、for、do、while、case、switch、default等语句自占一行，且if、for、

do、while等语句的执行语句部分无论多少都要加括号{}。

示例：如下例子不符合规范。 if (pUserCR == NULL) return;

应如下书写：

if (pUserCR == NULL) {

return; }

8. 对齐只使用空格键，不使用TAB键。

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

9. 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风

格，case语句下的情况处理语句也要遵从语句缩进要求。

10. 程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于