软件开发代码标准(C语言).doc

蒂莈XX产品研究部薅文档编号莆产品版本衿密级薅薂蚁蚅开发适用羃共页莃羈收文:XX产品研究部软件开发人员螅莄螁螇软件开发代码规范 袅(仅供内部使用)螅蒃螀羄拟制:袂周超羁蕿日期:肄2011-5-11芃审核:蚃莈莈日期:蚄膁核准:莁蒈肅日期:袂膀签发:薈蒆芀日期:袈蚈文档版本: 5蒄第二章排版 空行 代码行 代码行内的空格 对齐缩进 长行拆分 9芈第三章注释 通用规则 文件注释 函数注释 数据注释 代码注释 13莃第四章命名 通用命名规则 文件命名 类型命名 变量命名 常量命名 函数命名 枚举命名 宏命名 18罿第五章杂项 20薇莇薅文件修改记录蚁修改日期蚀版本莇修改页码、章节、条款蚂修改描述蒃作者荿2011-4--5-)【规则3-4-3】全局变量注释例子羀2)在“”、“”、“”中,增加对前缀、关键缩写词等可以适当全部大写的处理。螆周超肂螃蝿袆蒃芀蒈羆袃羂薀羆芄莀艿蚁修改日期蚀版本莇修改页码、章节、条款蚂修改描述蒃作者肆蚅肂肈膆螂薀袇第一章原则芅本文档的目的是提供一个公共的编码规范。膃这个规范详细阐述在编码时要怎样写、不要怎样写,旨在提高代码的可读性、可维护性,使代码易于管理,使所有人可以集中精力去实现内容,而非处理各种复杂的表现形式。节使代码易于管理的方法之一是增强代码一致性,让别人可以读懂你的代码是很重要的,保持统一编程风格意味着可以轻松根据“模式匹配”规则推断各种符号的含义。创建通用的、必需的习惯用语和模式可以使代码更加容易理解。虽然在某些情况下改变一些编程风格可能会是好的选择,但我们还是应该遵循一致性原则,尽量不这样去做。袀关键在于保持一致。莅薄第二章排版螀空行虿【规则2-1-1】在每个函数、结构体、枚举定义结束之后都要加空行。蒅羅【规则2-1-2】在一个函数体内,逻辑密切相关的语句之间不加空行,其它地方应加空行分隔。蒂莈structst1薅{莆…衿};蒁//空行薅enum薂{蚁…艿蚅};羃//空行螀//空行羄while(condition)袂{羁 statement1;蕿//空行肄 if(condition)芃 {蚃 statement2;莈 }莈 else蚄 {莃voidFunction1(…)羈{螅…莄}螁//空行螇voidFunction2(…)袅{螅…蒃}膁 statement3;莁 }蒈//空行肅 statement4;袂}膀函数之间的空行函数内部的空行薈蒆【规则2-1-3】相对独立的程序块之间、变量说明之后必须加空行。芀袈if(!)蚈{蚂...//programcode肂}蚇GetLockPhoneInfo(&st_lock_phone_info);螈if(!)肃{蒀...//programcode蚀}螈//空格蒄GetLockPhoneInfo(&st_lock_phone_info);膂不规范代码规范代码葿袇代码行蚆【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。蒁聿【规则2-2-2】if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。蝿螃intwidth,height,depth;//宽度高度深度膃袈intwidth; //宽度袈intheight; //高度膄intdepth; //深度蚁X=a+b;y=c+d;z=e+f;袁羈x=a+b;薅y=c+d;莃z=e+f;蚀if(width<height)dosomething();肈if(width<height)羆{螁dosomething();荿}膈for(initialization;condition;update)蒂for(initialization;condition;update)