通過設定專案輸出XML文件,來強制要求寫注釋

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

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

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

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

比如我們下面的**：

public class class1

///

///

///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 的注釋。

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

通過設定專案輸出XML文件,來強制要求寫注釋

很多程式設計師不習慣寫注釋。甚至是一些比較底層的函式都不寫注釋。過一段時間後呼叫時候，就不得不去檢視實現 才能知道某個邊界值的判斷是否在函式實現中判斷了。如果手工檢查是否寫注釋的話，很多時候因為工作一忙，就走與形式了。前幾天我的同事說在vs2005中找到的乙個超簡單的方式來強制寫注釋，如果公共函式沒...

通過XmlDocument讀寫Xml文件

通過xmldocument讀寫xml文件 xmlversion 1.0 encoding utf 8 students studentname 張平 courses coursename 語文?teachercomment 這裡是語文老師的批註 coursename 數學 teachercommen...

Android通過XML來定義Menu

直接在 中新增選單項，給選單項分組等，這是比較傳統的做法，它存在著一些不足。比如說，為了響應每個選單項，我們需要用常量來儲存每個選單項的id等。為此，android提供了一種更好的方式，就是把menu也定義為應用程式的資源，通過android對資源的本地支援，使我們可以更方便地實現選單的建立與響應。...