(精品)软件编码规范

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

1、个人收集整理仅供参考学习软件编码规范南京华设科技有限公司2009-10-09南京华设科技有限公司21-7-17第26页共26页个人收集整理仅供参考学习目录软件编码规范1一、版本说明3二、编码规范31、排版风格32、可理解性52．1、注释52．2、命名92．3、可维护性112．4、程序正确性、效率172．5、接口222．6、代码可测性232．7、代码编译26南京华设科技有限公司21-7-17第26页共26页个人收集整理仅供参考学习一、版本说明部门技术开发部文档用途软件编码规范主题词文档编号文档版本号V1.00文档日期2009-10-09最后修改日期文档作者朱志安项目负责人审核人项

2、目名称二、编码规范1、排版风格<规则1>程序块采用缩进风格编写，缩进为4个空格位。排版不混合使用空格和TAB键。<规则2>在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。采用这种松散方式编写代码的目的是使代码更加清晰。例如：(1)逗号、分号只在后面加空格南京华设科技有限公司21-7-17第26页共26页个人收集整理仅供参考学习printf("%d%d%d",a,b,c);(2)比较操作符,赋值操作符"="、"+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"

3、，位域操作符"<<"、"^"等双目操作符的前后加空格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;   

4、     //"->"指针前后不加空格由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如最内层的括号内侧(即左括号后面和右括号前面)不要加空格，因为在C/C++语言中括号已经是最清晰的标志了。另外，在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。最后，即使留空格，也不要连续留两个以上空格(为了保证缩进和排比留空除外)。<规则3>函数体的开始，类的定义，结构的定义，if、for、do、while、switch及case语句中的程序都应采用缩进方式，独占一行并且位于同一列，同时与引用它们的语句左对齐例如下例不符合规范。fo

5、r(...){   ...//程序代码}if(...){   ...//程序代码   }voidDoExam(void)   {   ...//程序代码   }应如下书写。for(...){   ...//程序代码}if(...){   ...//程序代码}voidDoExam(void南京华设科技有限公司21-7-17第26页共26页个人收集整理仅供参考学习){   ...//程序代码}<规则4>若语句较长（多于80字符），可分成多行写，划分出的新行要进行适应的缩进，使排版整齐，语句可读。memset(pData->pData+pData->nCount,0,        

6、   (m_nMax-pData->nCount)*sizeof(LPVOID));CNoTrackObject*pValue=           (CNoTrackObject*)_afxThreadData->GetThreadValue(m_nSlot);for(i=0,j=0;(i一行最多写一条语句。示例：如下例子不符合规范。rect.length=

7、0;rect.width=0;rect.length=rect.width=0;都应书写成：rect.length=0;rect.width=0;<规则6>不同类型的操作符混合使用时，使用括号给出优先级。如本来是正确的代码：if(year%4==0

8、

9、year%100!=0&&year%400==0)如果加上括号，则更清晰。if((year%4)==0

10、

11、((year%100)!=0&&(year%400)==0))2、可理解性2．1、注释注释的原则是有助于对程序的阅读理解，注释不宜太多也不