CC++编码规范

2019-08-31 15:29

本文从代码的可维护性(可读、可理解性、可修改性)、代码逻辑与效率、函数(模块)接口、可测试性四个方面阐述了软件编程规范,规范分成规则和建议两种,其中规则部分为强制执行项目,而建议部分则不作强制,可根据习惯取舍。 编码规范

1.排版风格

<规则 1> 程序块采用缩进风格编写,缩进为4个空格位。排版不混合使用空格和TAB键。

<规则2> 在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。

采用这种松散方式编写代码的目的是使代码更加清晰。例如:

(1) 逗号、分号只在后面加空格

printf(\

(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 ( ... )

{

... // 程序代码 }

void DoExam( void )

{

... // 程序代码

}

<规则4> 功能相对独立的程序块之间或for、if、do、while、switch等语句前后应加一空行。

示例:

例一:

if ( ! ValidNi( ni ) ) {

... // 程序代码 }

nRepssnInd = SsnData[ index ].nRepssnIndex ;

nRepssnNi = SsnData[ index ].ni ;

例二:

char *pContext;

int nIndex;

long lCounter;

pContext = new (CString);

if(pContext == NULL)

{

return FALSE;

}

<规则5> if、while、for、case、default、do等语句自占一行。

示例:

if( pUserCR == NULL ) {

return;

}

<规则6> 若语句较长(多于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 < NewKeyword.nWordLength ) ; i ++ , j ++ )

{

... // 程序代码 }

<规则7> 一行最多写一条语句。

示例: rect.length = 0 ;

rect.width = 0 ;

<规则8> 对结构成员赋值,等号对齐。

示例:

rect.top = 0;

rect.left = 0;

rect.right = 300;

rect.bottom = 200;

<规则9> #define的各个字段对齐

示例:

#define MAX_TASK_NUMBER 100 #define LEFT_X 10

#define BOTTOM_Y 400

<规则10> 不同类型的操作符混合使用时,使用括号给出优先级。

如本来是正确的代码:

if( year % 4 == 0 || year % 100 != 0 && year % 400 == 0 )

如果加上括号,则更清晰。

if((year % 4) == 0 || ((year % 100) != 0 && (year % 400) == 0))

2. 可理解性

1.1 注释

注释的原则是有助于对程序的阅读理解,注释不宜太多也不能太少,太少不利于代码理解,太多则会对阅读产生干扰,因此只在必要的地方才加注释,而且注释要准确、易懂、尽可能简洁。注释量一般控制在30%到50%之间。

<规则1> 程序在必要的地方必须有注释,注释要准确、易懂、简洁。

例如如下注释意义不大。

/* 如果bReceiveFlag 为 TRUE */

if ( bReceiveFlag == TRUE)

而如下的注释则给出了额外有用的信息。

/* 如果mtp 从连接处获得一个消息*/

if ( bReceiveFlag == TURE)

<规则2> 注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

示例:

例子1


CC++编码规范.doc 将本文的Word文档下载到电脑 下载失败或者文档不完整,请联系客服人员解决!

下一篇:苏教版说课集-小学四年级语文上册说课稿

相关阅读
本类排行
× 注册会员免费下载(下载后可以自由复制和排版)

马上注册会员

注:下载文档有可能“只有目录或者内容不全”等情况,请下载之前注意辨别,如果您已付费且无法下载或内容有问题,请联系我们协助你处理。
微信: QQ: