编程规范和范例剖析.docx

目录1 排版62 注释113 标识符命名184 可读性205 变量、结构226 函数、过程287 可测性368 程序效率409 质量保证4410 代码编辑、编译、审查5011 代码测试、维护5212 宏531 排版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：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。示例：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、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。示例：如下例子不符合规范。if (pUserCR == NULL) return;应如下书写：