规范

来源:互联网 发布:斯诺登爆料了哪些知乎 编辑:程序博客网 时间:2024/04/29 18:54
2.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++语言中括号已经是最清晰的标志了。8BR>另外,在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。
最后,即使留空格,也不要连续留两个以上空格(为了保证缩进和排比留空除外)。

<规则3> 函数体的开始,类的定义,结构的定义,if、for、do、while、switch及case语句中的程序都应采用缩进方式,憑捄蛻}捰禀独占一行并且位于同一列,同时与引用它们的语句左对齐
例如下例不符合规范。
for ( ... ) {
     ... // 程序代码
}

if ( ... )
     {
     ... // 程序代码
     }

void DoExam( void )
     {
     ... // 程序代码
     }

应如下书写。
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;
}

应如下书写
例一:
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;

应如下书写:
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 ;
rect.length = width = 0;

都应书写成:
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

应书写成:
#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))
原创粉丝点击