注釋這玩意我覺得多了沒啥不好，越詳細越好，為了防止注釋多了比較亂，就規則一下規則
以下也是綜合了網上好幾個地方的。
另外我加注釋一般是在c++的標頭檔案中。
ø列出：版權、作者、編寫日期和描述。
ø 示例：
author:
date:2010-08-25
description:描述主要實現的功能
每行不要超過80個字元的寬度。
/功能、輸入引數、輸出引數、返回值、呼叫關係（函式、表）等。
ø 示例：下面這段函式的注釋比較標準，當然，並不侷限於此格式，但上述資訊建議
要包含在內。
function: // 函式名稱如果其命名不是充分自注釋的，必須加以注釋。對資料結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋放在此域的右方。description: // 函式功能、效能等的描述
calls: // 被本函式呼叫的函式清單
table accessed: // 被訪問的表（此項僅對於牽扯到資料庫操作的程式）
table updated: // 被修改的表（此項僅對於牽扯到資料庫操作的程式）
input: // 輸入引數說明，包括每個引數的作
// 用、取值說明及引數間關係。
output: // 對輸出引數的說明。
return: // 函式返回值的說明
others: // 其它說明
ø 示例：可按如下形式說明列舉/資料/聯合結構。
/* sccp inte***ce with sccp user primitive message name */ø包括對其功能、取值範圍、哪些函式或過程訪問它以及訪問時注意事項等的說明。enum sccp_user_primitive
n_unitdata_ind, /* sccp notify sccp user unit data come */
n_notice_ind, /* sccp notify user the no.7 network can not */
/* transmission this message */
n_unitdata_req, /* sccp user's unit data transmission request*/
示例：
/* the errorcode when sccp translate */注釋總是加在程式的需要乙個概括性說明或不易理解或易理解錯的地方。注釋語言應該簡練、易懂而又含義準確，避免二義性；所採用的語種首選是中文，如有輸入困難、編譯環境限制或特殊需求也可採用英文。注釋應與其描述的**相近，對**的注釋統一放在其上方，避免在一行**或表示式中間使用注釋。上方注釋與其上面的**用空行隔開（較緊湊的**除外）。/* global title failure, as follows */
// 變數作用、含義
注意：注釋應與所描述內容進行同樣的縮排。
C 注釋規範
5.注釋 5.1.注釋的基本約定 注釋應該增加 的清晰度 保持注釋的簡潔，不是任何 都需要注釋的，過多的注釋反而會影響 的可讀性。注釋不要包括其他的特殊字元。建議先寫注釋，後寫 注釋和 一起完成 如果語句塊 比如迴圈和條件分枝的 塊 太長，巢狀太多，則在其結束 要加上注釋，標誌對應的開始語句。如果分...
c 注釋規範
模組開始必須以以下格式編寫模組注釋 模組編號 模組編號，可以引用系統設計中的模組編號 作用 對此類的描述，可以引用系統設計中的描述 編寫日期 模組建立日期，格式 yyyy mm dd 如果模組有修改，則每次修改必須新增以下注釋 log編號 修改描述 對此修改的描述 修改日期 模組修改日期 格式 yy...
c 注釋規範
列出 版權 作者 編寫日期和描述。示例 author date 2010 08 25 description 描述主要實現的功能 每行不要超過80個字元的寬度。列出 函式的目的 功能 輸入引數 輸出引數 返回值 呼叫關係 函式 表 等。示例 下面這段函式的注釋比較標準，當然，並不侷限於此格式，但上述...