5.注釋
5.1.注釋的基本約定
注釋應該增加**的清晰度；
保持注釋的簡潔，不是任何**都需要注釋的，過多的注釋反而會影響**的可讀性。
注釋不要包括其他的特殊字元。
建議先寫注釋，後寫**，注釋和**一起完成
如果語句塊（比如迴圈和條件分枝的**塊）**太長，巢狀太多，則在其結束「｝」要加上注釋，標誌對應的開始語句。如果分支條件邏輯比較複雜，也要加上注釋。
在vs2005環境中通過配置工程編譯時輸出xml文件檔案可以檢查注釋的完整情況，如果注釋不完整會報告編譯警告；
5.2.注釋型別
5.2.1.塊注釋
/// 作者，建立日期，修改日期
對類和介面的注釋必須加上上述標記，對方法可以視情況考慮
5.2.2.行注釋
主要用在方法內部，對**，變數，流程等進行說明。整個注釋佔據一行。
5.2.3.尾隨注釋
與行注釋功能相似，放在**的同行，但是要與**之間有足夠的空間，便於分清。例：
int m = 4 ; // 注釋
如果乙個程式塊內有多個尾隨注釋，每個注釋的縮排要保持一致。
5.3.注釋哪些部分
專案
注釋哪些部分引數
引數用來做什麼
任何約束或前提條件
字段/屬性
字段描述
類類的目的
已知的問題
類的開發/維護歷史
介面目的
它應如何被使用以及如何不被使用
區域性變數
用處/目的
成員函式注釋
成員函式做什麼以及它為什麼做這個
哪些引數必須傳遞給乙個成員函式
成員函式返回什麼
已知的問題
任何由某個成員函式丟擲的異常
成員函式是如何改變物件的
包含任何修改**的歷史
如何在適當情況下呼叫成員函式的例子適用的前提條件和後置條件
成員函式內部注釋
控制結構
**做了些什麼以及為什麼這樣做
區域性變數
難或複雜的**
處理順序
5.4.程式修改注釋
新增**行的前後要有注釋行說明，對具體格式不作要求，但必須包含作者，新增時間，新增目的。在新增**的最後必須加上結束標誌；
刪除**行的前後要用注釋行說明，刪除**用注釋原有**的方法。注釋方法和內容同新增；刪除的**行建議用#region *** #endregion **段摺疊，保持**檔案乾淨整潔
修改**行建議以刪除**行後再新增**行的方式進行（針對別人的**進行修改時，必須標明，對於自己的**進行修改時，酌情進行）。注釋方法和內容同新增；
c 注釋規範
模組開始必須以以下格式編寫模組注釋 模組編號 模組編號，可以引用系統設計中的模組編號 作用 對此類的描述，可以引用系統設計中的描述 編寫日期 模組建立日期，格式 yyyy mm dd 如果模組有修改，則每次修改必須新增以下注釋 log編號 修改描述 對此修改的描述 修改日期 模組修改日期 格式 yy...
c 注釋規範
列出 版權 作者 編寫日期和描述。示例 author date 2010 08 25 description 描述主要實現的功能 每行不要超過80個字元的寬度。列出 函式的目的 功能 輸入引數 輸出引數 返回值 呼叫關係 函式 表 等。示例 下面這段函式的注釋比較標準，當然，並不侷限於此格式，但上述...
C 注釋規範
注釋這玩意我覺得多了沒啥不好，越詳細越好，為了防止注釋多了比較亂，就規則一下規則 以下也是綜合了網上好幾個地方的。另外我加注釋一般是在c 的標頭檔案中。列出 版權 作者 編寫日期和描述。示例 author date 2010 08 25 description 描述主要實現的功能 每行不要超過80個...