使用Nuget 安裝 Docfx,經過測試需要選擇 docfx.console,我使用穩定版的;
由於docfx 是開放的,可以到官網取得相關說明;安裝好之後觀察方案總管,多出了一些檔案,其中 docfx.json 為設定相關參數;
打開專案資料夾,可以看到有一個 _site 的資料夾,裡面就是組成說明文件的相關檔案,可以架起來變成站台,其中 api / toc.html 可以看到 lib 的說明,但若是直接使用檔案總管開啟的話,部分左上方目錄會無法正常顯示,由於JavaScript受跨網域存取限制,建議使用IIS 建置站台即可正常
怎麼將程式碼註解產生為說明文件呢?在「專案」屬性「建置」頁面勾選xml 文件建置選項,編譯後即可產生對應文件
另外,因為我們設定了產生文件,所以每次編譯都會變得比較久(如下圖),但其實僅需
Technorati Tags: visual studio
要確認 release 的時候,才產生文件,可以透過相關設定來處理首先,同樣來到專案屬性的「建置」頁籤,在 release 組態下,加入條件式編譯符號,這邊使用 「DOCFX」;接著打開專案檔(.csproj),加入相關設定,這樣就可以避免開發的時候編譯太久
參考: