很多程式設計師不習慣寫註釋。甚至是一些比較底層的函式都不寫註釋。過一段時間後呼叫時候，就不得不去檢視實現程式碼，才能知道某個邊界值的判斷是否在函式實現中判斷了。

如果手工檢查是否寫註釋的話，很多時候因為工作一忙，就走與形式了。

前幾天我的同事說在VS2005中找到的一個超簡單的方式來強制寫註釋，如果公共函式沒有寫註釋，或者注視書寫錯誤，編譯程式的時候就會報警告。

這個設定就是我們很多人都知道的定義輸出的XML 文件，參見下圖：

比如我們下面的程式碼：

public class Class1
{

public void aa()
{
}

///
///
///
///
protected void bb(int dd)
{
}

private void cc()
{
}

internal void dd()
{
}
}

就會報四個警告：

1、類沒有寫註釋

2、公共函式 public void aa() 沒有寫註釋

3、void bb(int dd) 這個函式註釋中出現了不存在的引數 ff

4、void bb(int dd) 這個函式沒有寫 引數 dd 的註釋。

通過上面一個簡單的設定，就可以強制團隊的成員寫註釋。