個人C++コメント仕様

一、文章の由来
久しぶりにブログを书いて、最近プロジェクトをして、プロジェクトをする过程の中で多种の注釈の问题に出会って、今1つの注釈の规范を整理して、后で私はこの规范に従って注釈します~~良い注釈の习惯を身につけてコードの可読性を高めることに役立ちます(注:すべての人の习惯は异なって、自分の好きな注釈の风格を探し当てることができます)
二、具体的な規範
合計行数の50%を占めるコメントを要求する項目もあります.
2.1ソースファイルヘッダコメント
Øリスト:作成者、作成日、説明.Ø例:

/* 
* Copyright:bupt
* funtion:        
* Date:2015-09-01
* Author: Bill Wang
*/

行ごとに80文字の幅を超えないでください.
2.2関数ヘッダコメント
Ø:機能、入力パラメータ、出力パラメータ、戻り値、呼び出し関係(関数、テーブル)などを一覧表示します.Ø例:以下の関数の注釈比較基準は、もちろん、この形式に限定されませんが、上記の情報は含めることをお勧めします.

/*************************************************
Function:       //     
Description:    //     、      
Calls:          //            
Table Accessed: //      （                ）
Table Updated: //      （                ）
Input:          //       ，        
 //  、          。
Output:         //         。
Return:         //         
Others:         //     
*************************************************/

3.3データ構造宣言の注釈(配列、構造、クラス、列挙などを含む)
これが最も一般的な注釈で、複数のスラッシュで注意を引くことができます.
名前が十分に自己注釈されていない場合は、注釈を付ける必要があります.データ構造に対する注釈はその上の隣接位置に置くべきで、下に置くことはできない.構造内の各ドメインに対するコメントは、このドメインの右側に配置されます.
Ø例:列挙/データ/連合構造は以下の形式で説明できます.

/////!!!       
enum WinSwitcherType{
    WS_NONE = 0, //   
    WS_NAME, //  
    WS_PORT_SINGLE,//   
    WS_PORT_DOUBLE,//   
    WS_VALUE_TEXT,//    
    WS_VALUE_INT,//       
    WS_VALUE_DOUBLE,//        
    WS_VALUE_BOOL,//    
    WS_FILW_PATH, //    
    WS_INPORT //    
};

3.4グローバル変数のコメント
Øには、その機能、値範囲、どのような関数またはプロシージャがアクセスするか、アクセス時の注意事項などの説明が含まれています.Ø例:

/* The ErrorCode when SCCP translate */
/* Global Title failure, as follows */      //     、  

—END—
参考文献
[1] http://blog.csdn.net/lincyang/article/details/6020785