软件开发代码规范(c语言)

《软件开发代码规范(c语言)》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、XX产品研究部文档编号产品版本密级开发适用共页收文：XX产品研究部软件开发人员软件开发代码规范(仅供内部使用)拟制：周超日期：2011-5-11审核：日期：核准：日期：签发：日期：文档版本：V0.11目录第一章原则5第二章排版62.1空行62.2代码行72.3代码行内的空格72.4对齐缩进82.5长行拆分9第三章注释113.1通用规则113.2文件注释113.3函数注释123.4数据注释133.5代码注释13第四章命名164.1通用命名规则164.2文件命名164.3类型命名164.4变量命名174.5常量命名184.6函数命名184.7枚举命名184

2、.8宏命名18第五章杂项20文件修改记录修改日期版本修改页码、章节、条款修改描述作者2011-4-290.1创建初稿周超2011-5-110.113.3数据注释4.3类型命名4.4变量命名4.6函数命名1）修改3.4数据注释【规则3-4-3】全局变量注释例子2）在“4.3类型命名”、“4.4变量命名”、“4.6函数命名”中，增加对前缀、关键缩写词等可以适当全部大写的处理。周超第一章原则本文档的目的是提供一个公共的编码规范。这个规范详细阐述在编码时要怎样写、不要怎样写，旨在提高代码的可读性、可维护性，使代码易于管理，使所有人可以集中精力去实现内容，而非处

3、理各种复杂的表现形式。使代码易于管理的方法之一是增强代码一致性，让别人可以读懂你的代码是很重要的，保持统一编程风格意味着可以轻松根据“模式匹配”规则推断各种符号的含义。创建通用的、必需的习惯用语和模式可以使代码更加容易理解。虽然在某些情况下改变一些编程风格可能会是好的选择，但我们还是应该遵循一致性原则，尽量不这样去做。关键在于保持一致。第二章排版2.1空行l【规则2-1-1】在每个函数、结构体、枚举定义结束之后都要加空行。l【规则2-1-2】在一个函数体内，逻辑密切相关的语句之间不加空行，其它地方应加空行分隔。structst1{…};//空行enum

4、{…};//空行voidFunction1(…){…}//空行voidFunction2(…){…}//空行while(condition){statement1;//空行if(condition){statement2;}else{statement3;}//空行statement4;}函数之间的空行函数内部的空行l【规则2-1-3】相对独立的程序块之间、变量说明之后必须加空行。if(!is_lock_card_succ){...//programcodeif(!is_lock_card_succ){...//programcode}GetLockP

5、honeInfo(&st_lock_phone_info);}//空格GetLockPhoneInfo(&st_lock_phone_info);不规范代码规范代码2.1代码行l【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。l【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。intwidth,height,depth;//宽度高度深度intwidth;//宽度intheight;//高度intdept

6、h;//深度X＝a+b;y=c+d;z=e+f;x=a+b;y=c+d;z=e+f;if(width

7、空格。const、static等关键字之后至少要留一个空格，否则无法辨析关键字；if、for、while、switch等关键字之后应留一个空格再跟左括号‘(’，以突出关键字。l【规则2-3-2】函数名之后不要留空格，紧跟左括号‘(’，以与关键字区别。l【规则2-3-3】‘(’向后紧跟，‘)’、‘,’、‘;’向前紧跟，紧跟处不留空格。l【规则2-3-4】‘,’之后要留空格，如Function(x,y,z)。如果‘;’不是一行的结束符号，其后要留空格，如for(initialization;condition;update)。l【规则2-3-5】赋值操作符

8、、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”“>=”、“<=”、“+”