忽略 XML Comments

當你在Visual Studio 中設定專案必需輸入註解(XML Comment)後，設定方式如下圖：

當你的專案勾選「XML Document file」，若程式中 public methods 或是public perprites 沒有加上註解，在Build 時就會出現警告(warning)，用來提醒相關程式撰寫人員必須補上相關說明。這其實是一個很好的、也很方便的功能。這些註解所產生的XML，將會幫助其它 reference 這個元件的專案或程式提供一個更好的IntellSense 說明。(警告，如下圖所示)

在真實的專案中使用這個功能，要求整個團隊在每一個方法及屬性上撰寫註解。Build 之後卻發現連 Designer.cs 或是 Reference 這一類由Visual Studio 自動產生的類別都會出現相關的Warning。

我們該如何忽略這些類別的Warning呢？(因為它非Coding出來的，而是自動產生的)。

可以利用

#pragma warning disable 1591

加在相關類別的第一行，這些類別就不會再產生警告(warning)。

另外，這個指令可以用在程式碼中，例如在產生警告該行程式碼(例如，method)的前一行，用來忽略特定的method。在該行程式碼的下一行，可以用另一個指令來取消強制忽略警示。

#pragma warning restore 1591