Visual Studio 中 Object Browser 無法顯示註解

Object Browser 無法顯示註解

最近都在開發 Class Library 所以有機會使用 Object Browser 來看看自己寫了什麼東西,順便看看哪些地方註解忘記寫上去或是有解別錯漏字的,配合【增進撰寫註解速度的小套件 GhostDoc】更是如虎添翼。

但是,寫出來的 Class Library Dll 檔案拿到別人的電腦中引用參考,今天我卻發現在團隊的成員電腦中的 Object Browser 卻無法顯示註解!?都已經用了那麼久的 Class Library,看不到註解也不會講一聲?難怪之前有時候都會問我,那個 xxx 屬性是做什麼用的?那個 yyy 方法的回傳值是什麼?

原來,一是因為 Visual Studio 的 intellisense 還是會提示註解說明,二是因為團隊成員沒有看 Object Browser 的好習慣,加上開發 Class Library 專案中的 Object Browser 的環境,跟引用別人 Dll 檔案的 Object Browser 的環境是有所差別的!會造成引用別人 Dll 而在 Object Browser 中看不到註解的原因,是因為我忘記在開發 Class Library 的專案中產生相對應的 XML 檔案,只有將 Dll 檔案交給團隊成員使用。

XML-0000 

解決的辦法就是設定專案的屬性,在【Build】標籤頁下,Output 部分記得要勾選產生【XML document file】,當編譯 Class Library 的時候就會自動產生 DLL 與 XML 檔案了。以後,只要將 DLL 與 XML 檔案將給團隊成員,兩個檔案放至在相同目錄待團隊成員引用參考,就可以在 Object Browser 看到註解了。