5. 註釋
5.1. 註釋的基本約定
註釋應該增加代碼的清晰度；
保持註釋的簡潔，不是任何代碼都需要註釋的，過多的註釋反而會影響代碼的可讀性。
註釋不要包括其他的特殊字符。
建議先寫註釋，後寫代碼，註釋和代碼一起完成
如果語句塊（比如循環和條件分枝的代碼塊）代碼太長，嵌套太多，則在其結束“｝”要加上註釋，標誌對應的開始語句。如果分支條件邏輯比較複雜，也要加上註釋。
在VS2005環境中通過配置工程編譯時輸出XML文檔文件可以檢查註釋的完整情況，如果註釋不完整會報告編譯警告；
5.2. 註釋類型
5.2.1. 塊註釋
主要用來描述文件，類，方法，算法等，放在所描述對象的前邊。具體格式以IDE編輯器輸入“///”自動生成的格式爲準，另外再附加我們自定義的格式，如下所列：
/// <Remark>作者，創建日期，修改日期</Remark >
對類和接口的註釋必須加上上述標記，對方法可以視情況考慮
5.2.2. 行註釋
主要用在方法內部，對代碼，變量，流程等進行說明。整個註釋佔據一行。
5.2.3. 尾隨註釋
與行註釋功能相似，放在代碼的同行，但是要與代碼之間有足夠的空間，便於分清。例：
int m = 4 ; // 註釋
如果一個程序塊內有多個尾隨註釋，每個註釋的縮進要保持一致。
5.3. 註釋哪些部分
|
項目 |
註釋哪些部分 |
|
參數 |
參數用來做什麼 任何約束或前提條件 |
|
字段/屬性 |
字段描述 |
|
類 |
類的目的 已知的問題 類的開發/維護歷史 |
|
接口 |
目的 它應如何被使用以及如何不被使用 |
|
局部變量 |
用處/目的 |
|
成員函數註釋 |
成員函數做什麼以及它爲什麼做這個 哪些參數必須傳遞給一個成員函數 成員函數返回什麼 已知的問題 任何由某個成員函數拋出的異常 成員函數是如何改變對象的 包含任何修改代碼的歷史 如何在適當情況下調用成員函數的例子適用的前提條件和後置條件 |
|
成員函數內部註釋 |
控制結構 代碼做了些什麼以及爲什麼這樣做 局部變量 難或複雜的代碼 處理順序 |
5.4. 程序修改註釋
新增代碼行的前後要有註釋行說明，對具體格式不作要求，但必須包含作者，新增時間，新增目的。在新增代碼的最後必須加上結束標誌；
刪除代碼行的前後要用註釋行說明，刪除代碼用註釋原有代碼的方法。註釋方法和內容同新增；刪除的代碼行建議用#region XXX #endregion 代碼段摺疊，保持代碼文件乾淨整潔
修改代碼行建議以刪除代碼行後再新增代碼行的方式進行（針對別人的代碼進行修改時，必須標明，對於自己的代碼進行修改時，酌情進行）。註釋方法和內容同新增；