Visual Studio 利用 DocFx 產生規格文件

建立文件也是開發專案的一環,Visual Studio 目前可以透過 DocFx 套件的安裝,在程式開發的過程中,自動化文件的產出與同步維護作業。建立一個標準的ASP.NET MVC專案,開啟「管理 NuGet 套件」功能,於其中找到 DocFx 套件。按一下「安裝」按鈕完成完裝程序。


接下來重新編譯專案,並且執行任一網頁確認專案可以正常在瀏覽器中檢視。


以此專案作說明,於其中輸入 http://localhost:7559/_site/ (根目錄 /_site)網址,瀏覽器就會顯示根據專案內容產生的程式文件,並以網頁格式呈現。


按一下導覽列的 API Documentation 連結,可以切換至專案 API 內容敘述頁面。展開其中的內容,可以看到與專案內容同步的輸出文件,左邊的選單對應專案中的各種類別內容。於選單中點擊 DocFxDemo.Controllers > HomeController 將其展開:


這是 DocFx 針對 ASP.NET 專案建立時的預設內容所產生的對應文件。現在開啟控制器 HomeController 新增內容如下:


反白的區域是新增的部份,完成之後編譯專案,接下來重新進入文件頁,就可以看到新增的文件內容了。


沒有留言: