C# 編程規範 - 上 (5) 註釋規範與聲明規則

3.2 文件化註釋

使用 XML 標籤，介面/類別/方法/屬性/字段均應標註，可自動產生文件。範例：

/// 
MyMethod is a method in the MyClass class.
/// Here's how you could make a second paragraph in a description.
///  for information about output statements.
/// 
/// 
/// 
public static void MyMethod(int Int1) { }

3.3 程式碼註釋 (停用代碼)

/*
[修改標識]
[修改原因]
... (source code)
*/

3.4 單行註釋

• 方法內代碼說明：// 註釋 或獨立行。
• 變數宣告後/大括號後註釋：if (1==1) // always true。

4. 宣告規則

• 每行一宣告，按字母序排列。
• 宣告時初始化。

int level;  // 推薦
int size;   // 推薦
int x, y;   // 不推薦