1 / 28
文档名称:

(精品)软件编码规范.doc

格式:doc   大小:122KB   页数:28页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

(精品)软件编码规范.doc

上传人:一花一叶 2019/4/4 文件大小:122 KB

下载得到文件列表

(精品)软件编码规范.doc

相关文档

文档介绍

文档介绍:软件编码规范南京华设科技有限公司2009-10-09目录软件编码规范 1一、 版本说明 3二、编码规范 31、排版风格 32、可理解性 、注释 、命名 、可维护性 、程序正确性、效率 、接口 、代码可测性 、代码编译 -10-09最后修改日期文档作者朱志安项目负责人审核人项目名称二、编码规范1、排版风格<规则1>程序块采用缩进风格编写,缩进为4个空格位。排版不混合使用空格和TAB键。<规则2>在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。采用这种松散方式编写代码的目的是使代码更加清晰。例如:(1)逗号、分号只在后面加空格printf("%d%d%d",a,b,c);(2)比较操作符,赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格if(lCurrentTime>=MAX_TIME_VALUE)a=b+c;a*=2;a=b^2;(3)"!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格*pApple='a';        //内容操作"*"与内容之间flag=!bIsEmpty;            //非操作"!"与内容之间p=&cMem;            //地址操作"&"与内容之间i++;                //"++","--"与内容之间(4)"->"、"."前后不加空格p->id=pId;        //"->"指针前后不加空格由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如最内层的括号内侧(即左括号后面和右括号前面)不要加空格,因为在C/C++语言中括号已经是最清晰的标志了。另外,在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。最后,即使留空格,也不要连续留两个以上空格(为了保证缩进和排比留空除外)。<规则3>函数体的开始,类的定义,结构的定义,if、for、do、while、switch及case语句中的程序都应采用缩进方式,独占一行并且位于同一列,同时与引用它们的语句左对齐 例如下例不符合规范。for(...){   ...//程序代码}if(...){   ...//程序代码   }voidDoExam(void)   {   ...//程序代码   }应如下书写。for(...){   ...//程序代码}if(...){   ...//程序代码}voidDoExam(void){   ...//程序代码}<规则4> 若语句较长(多于80字符),可分成多行写,划分出的新行要进行适应的缩进,使排版整齐,语句可读。memset(pData->pData+pData->nCount,0,           (m_nMax-pData->nCount)*sizeof(LPVOID));CNoTrackObject*pValue=           (CNoTrackObject*)_afxThreadData->GetThreadValue(m_nSlot);for(i=0,j=0;(i<BufferKeyword[WordIndex].nWordLength)                 &&(j<);i++,j++){   ...//程序代码}<规则5> 一行最多写一条语句。示例:如下例子不符合规范。=0;=0;==0;都应书写成:=0;=0;<规则6> 不同类型的操作符混合使用时,使用括号给出优先级。如本来是正确的代码:if(year%4==0||year%100!=0&&year%400==0)如果加上括号,则更清晰。if((year%4)==0||((year%100)!=0&&(year%400)==0))2、、注释 注释的原则是有助于对程序的阅读理解,注释不宜太多也不能太少,太少不利于代码理解,太多则会对阅读产生干扰,因此只在必要的地方才加注释,而且注释要准确、易懂、尽可能简洁。注释量一般控制在30%到50%之间。<规则1> 程序在必要的地方必须有注释,注释要准确、易懂、简洁。例如如下注释意义不大。/*如果bReceiveFlag为TRUE*/if(