c++注釋規範

給代碼加注釋：

1

源檔案頭部注釋

Ø 列出：版權、作者、編寫日期和描述。

Ø 示例：

每行不要超過80個字元的寬度。

2 函數頭部注釋

Ø 列出：函數的目的/功能、輸入參數、輸出參數、傳回值、調用關系（函數、表）等。

Ø 示例：下面這段函數的注釋比較标準，當然，并不局限于此格式，但上述資訊建議

要包含在内。

3 資料結構聲明的注釋(包括數組、結構、類、枚舉等)

如果其命名不是充分自注釋的，必須加以注釋。對資料結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋放在此域的右方。

Ø 示例：可按如下形式說明枚舉/資料/聯合結構。

enum SCCP_USER_PRIMITIVE

{

N_UNITDATA_IND,

N_NOTICE_IND,

N_UNITDATA_REQ,

};

4 全局變量的注釋

Ø 包括對其功能、取值範圍、哪些函數或過程存取它以及存取時注意事項等的說明。

示例：

// 變量作用、含義

5 對代碼的注釋

注釋總是加在程式的需要一個概括性說明或不易了解或易了解錯的地方。注釋語言應該簡練、易懂而又含義準确，避免二義性；所采用的語種首選是中文，如有輸入困難、編譯環境限制或特殊需求也可采用英文。注釋應與其描述的代碼相近，對代碼的注釋統一放在其上方，避免在一行代碼或表達式中間使用注釋。上方注釋與其上面的代碼用空行隔開（較緊湊的代碼除外）。

注意：注釋應與所描述内容進行同樣的縮進。