C语言编码规范案例.doc

C语言编码规范 文件编号：NSRD901 生效日期：2003-6-6 版本：1.0 总页数：36 正文：36 附录：0 编制：申健 审核：赵岗 批准：曹斌 沈阳东软软件股份有限公司 网络安全事业部 文件修改控制 修改记录编号 修改页码及条款 修改人 审核人 批准人 修改日期 引言 摘要 良好的编程风格是提高程序可靠性非常重要的手段，也是大型项目多人合作开发的技术基础。本规范的目的在于通过规范定义来避免不好的编程风格，增强程序的易读性，提高代码的效率。 适用范围 本规定适用于网络安全事业部内基于Linux系统的C语言源程序编写。使用Windows系统的VC开发的程序员也可以将本规范中的相关章节作为参考。 格式说明 下面是本规范中不同的排版格式所代表的含义： 规则: 编程时必须遵守的原则。 建议: 编程时必须加以考虑的原则。 说明: 对规则或建议进行必要的解释。 实例： 规则或建议从正、反两个方面给出例子。 目录 1. 程序排版 3 2. 注释 6 3. 可读性 11 4. 文件 13 5. 命名标准 14 5.1 命名的一般方针 14 5.2 结构、联合的命名 15 5.3 宏的命名 15 6. 定义的位置 16 7. 宏定义和预处理命令 17 8. 用户自定义类型 18 9. 变量 21 10. 操作符 22 11. 指针 23 12. 函数 24 13. 调试、测试代码 29 14. 质量保证 30 15. 效率和质量 33 程序排版 规则：较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 建议：一行程序以小于80字符为宜。 示例： perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( long ); 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)); 规则：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。 建议：长表达式在低优先级操作符处划分新行 示例： if ((taskno max_act_task_number) (n7stat_stat_item_valid (stat_item))) { ... // program code } for (i = 0, j = 0; (i buffer_keyword[word_index].word_length) (j new_keyword.word_length); i++, j++) { ... // program code } for (i = 0, j = 0; (i first_word_length) (j second_word_length); i++, j++) { ... // program code } 规则：若函数的参数较长，则要进行适当的划分。 示例 n7stat_str_compare((BYTE *) stat_object, (BYTE *) (act_task_table[taskno].stat_object), sizeof (_STAT_OBJECT)); n7stat_flash_act_duration( stat_item, fra