我的代码格式

1. 在.h/.cpp的开头应有一段格式统一的说明，格式如下：

// 
//
// 文 件 名：
// 简    述：
//  作    者：OutSky
// 最后更新：xxxx年xx月xx日
/

2.对于主要功能函数应有注释说明。格式为：

 

/
//    函 数 名:    
//    简    述:    
//    参    数:(参数名、意义)
//    返 回 值:(返回值类型、意义)
//    注    意:(需要注意的信息)
/

3. 每列代码的长度推荐为80列，最长不得超过120列；折行以对齐为准。

例：HANDLE KSOpenFile( const   char  cszFileName[], 
int  nMode); 
或者： 
BOOL KSReadFile( 
HANDLE hFile, 
void   * pvBuffer, 
int  nReadSize, 
int   * pnReadSize 
); 

4. 循环、分支代码，判断条件与执行代码不得在同一行上。

例：正确： 
if ( - 2   ==  n) 
    n  =   1 ; 
else  
    n  =   2 ; 
不得写做： 
if  ( - 2   ==  n) n  =   1 ; 
else  n  =   2 ; 

5. 指针的定义，* 号紧接变量名。

例：正确：
int   * pNum;
错误1：
int *  pNum;
错误2：
int   *  pNum;

6.返回指针时，*号紧跟返回值类型。

例：正确：
int *  fun();
错误1：
int   * fun();
错误2：
int   *  fun();

7. 函数入口参数有缺省值时，应注释说明。

例: 
BOOL KSSaveToFile( 
const   char  cszFileName[], 
BOOL bCanReplace  /**/ /* = TRUE */  
); 

8. else if 必须写在一行。

9.‘{’必须另起一行。‘{’与‘}’必须在同一列上。类中定义的内联函数等特殊情况除外。

例：正确： 
if  (i  >   0 ) 
... { 
m = 1; 
n++; 
}  
不得写做： 
if  (i  >   0 )  ... { 
m = 1; 
n++; 
}  

 

10.if语句、while语句格式：

情况1：条件只有一个，则在条件语句两侧各空一格，如：
if ( a < b )
while ( a < b )
情况2：条件多于一个，则条件之间空格，两侧不空格，如：
if (a < b  &&  d < c)
while (a < b  &&  d < c)

11.for语句格式：

空格位置如例：
类型1：  for ( int  a = 0 ; a < 10 ;  ++ a)
类型2：  for (a = 0 , b = 1 ; a < 10 && b < 10 ;  ++ a, ++ b)

12.普通注释格式：

情况1：注释内容较少，所要注释的代码也很短。注释放在代码同一行的右边。
int  nNum;     //  小球的个数
情况2：注释内容不多，但所要注释的代码很长。注释放在代码上一行。
//  所有物品的总数
int  nNum  =  nNumObjA + nNumObjB + nNumObjC + ......
情况3：注释的内容很多，放在代码上面，用 /**/ /* */ 注释。
/**/ /*
1.什么什么什么
2.什么什么什么
3.。。。
*/

继续添加。。。