编程规范案例.doc

软件编程规范培训实例与练****问题分类 1逻辑类问题( A类)-指设计、编码中出现的计算正确性和一致性、程序逻辑控制等方面出现的问题,在系统中起关键作用,将导致软件死机、功能正常实现等严重问题; 接口类问题( B类)-指设计、编码中出现的函数和环境、其他函数、全局/局部变量或数据变量之间的数据/控制传输不匹配的问题,在系统中起重要作用,将导致模块间配合失效等严重问题; 维护类问题(C类)-指设计、编码中出现的对软件系统的维护方便程度造成影响的问题,在系统中不起关键作用,但对系统后期维护造成不便或导致维护费用上升; 可测试性问题(D类)-指设计、编码中因考虑不周而导致后期系统可测试性差的问题。?处罚办法问题发生率: P=D/S D=D A+ B+ C其中: P-问题发生率 D-1个季度内错误总数 D A-1个季度内 A类错误总数 D B-1个季度内 B类错误总数 D C-1个季度内 C类错误总数 S-1个季度内收到问题报告单总数 1)当 D≥3时,如果 P≥3%,将进行警告处理,并予以公告; 2)当 D≥5时,如果 P≥5%,将进行罚款处理,并予以公告。目录一、逻辑类代码问题第 5页 1 、变量/ 指针在使用前就必须初始化第5页【案例 】第5页 2 、防止指针/ 数组操作越界第5页【案例 】第5页【案例 】第6页【案例 】第7页【案例 】第8页 3 、避免指针的非法引用第9页【案例 】第9页 4 、变量类型定义错误第10页【案例 】第10页 5 、正确使用逻辑与&& 、屏蔽& 操作符第17页【案例 】第17页 6 、注意数据类型的匹配第18页【案例 】第18页【案例 】第18页 7 、用于控制条件转移的表达式及取值范围是否书写正确第20页【案例 】第20页【案例 】第21页【案例 】第22页 8 、条件分支处理是否有遗漏第24页【案例 】第24页 9 、引用已释放的资源第26页【案例 】第26页 10 、分配资源是否已正确释放第28页【案例 】第28页【案例 】第29页【案例 】第30页【案例 】第 32页【案例 】第 33页【案例 】第 35页【案例 】第 38页 11 、防止资源的重复释放第 39页【案例 】第 39页 12 、公共资源的互斥性和竞用性第 40页【案例 】第 40页【案例 】第 40页二、接口类代码问题第 43页 1 、对函数参数进行有效性检查第43页【案例 】第43页【案例 】第43页【案例 】第44页【案例 】第46页【案例 】第47页【案例 】第48页 2 、注意多出口函数的处理第49页【案例 】第49页三、维护类代码问题第51页 1、统一枚举类型的使用第51页【案例 】第51页 2、注释量至少占代码总量的 20 % 第51页【案例 】对 XXX 产品 BAM 某版本部分代码注释量的统计第51页四、产品兼容性问题第52页 1 、系统配置、命令方式第 52页【案例 】第 52页【案例 】第 53页 2 、设备对接第 54页【案例 】第 54页 3 、其他第 55页【案例 】第 55页五、版本控制问题第 58页 1 、新老代码中同一全局变量不一致第58页【案例 】第58页六、可测试性代码问题第59页 1 、调试信息/ 打印信息的正确性第59页【案例 】第59页一、逻辑类代码问题 1、变量/指针在使用前就必须初始化【案例 】 C语言中最大的特色就是指针。指针的使用具有很强的技巧性和灵活性, 但同时也带来了很大的危险性。在 XXX 的代码中有如下一端对指针的灵活使用: ...... _UC *puc_card_config_tab; ...... Get_Config_Table( AMP_CPM_CARD_CONFIG_TABLE, &ul_card_config_num, &puc_card_config_tab, use_which_data_area ); ...... b_middle_data_ok = generate_trans_middle_data_from_original_data( puc_card_config_tab, Ul_card_config_num) ..