使用 docfx 產生類別圖及文件說明

產生類別圖

預設若沒安裝類別圖設計則不會有這個功能可以參考這篇步驟安裝

勾選該選項後即可使用三條斜槓進行註解即可產生自己想要說明

下載編譯好的 docfx

https://dotnet.github.io/docfx/

丟到 d:\docfx

cmd 切換目錄到任意資料夾執行以下命令即會生出預設的樣板

D:\docfx\docfx init -q
D:\docfx\docfx docfx_project\docfx.json
D:\docfx\docfx serve docfx_project/_site

確認都 ok 以後使用以下命令,看自己專案位置在哪邊就指到哪

D:\docfx\docfx metadata D:\TestV1\TestV1\TestV1.csproj

成功後會在目前的資料夾 (linux 的 pwd) 生出 _api 資料夾,將內容全部複製到 docfx_project\api 底下即可

接著在執行以下命令一次開啟 http://localhost:8080 就可以完整的看到產生的文件

D:\docfx\docfx docfx_project\docfx.json
D:\docfx\docfx serve docfx_project/_site

 

將網站轉換為 pdf 文件 (效果不好,忘了以前怎麼處理的)

接著安裝 wkhtmltopdf

cd C:\Program Files\wkhtmltopdf\bin
wkhtmltopdf http://localhost:8080/api/TestV1.html D:\d.pdf

 


發佈留言