【Unity實用工具】API文檔生成工具-DocFX

安裝DocFX

用於構建和發佈.NET項目的API文檔的工具
DocFX下載地址(點擊下載
下載docfx.zip解壓到心儀目錄即可

配置環境

win + R 輸入 sysdm.cpl 按Enter,打開系統屬性窗口
點擊“高級”選項卡下“環境變量”按鈕,打開環境變量窗口
點擊系統變量下“新建”按鈕,輸入變量名變量值(路徑),確定
在這裏插入圖片描述
找到系統變量下“Path”雙擊進入編輯狀態,點擊“新建”,輸入“%DocFX%”(你的變量名),一點擊3次確認按鈕退出,直至退出“系統屬性”窗口。
在這裏插入圖片描述

生成DocFX項目

新建一個目錄(DocFX Project目錄),用來生成DocFX項目。打開目錄,按住 Shift + 鼠標右鍵 ,打開 Powershell窗口。

docfx init -q:使用此命令在目錄下初始一個,生成名爲docfx_project的默認 docfx 項目
-q:這個參數表示忽略詢問,直接生成。如果需要自定義配置,可取消 -q 這個參數。

docfx_project\src:目錄用來存放你需要生成文檔的項目,直接把整個項目(解決方案)放進去即可。
在這裏插入圖片描述
docfx.json是docfx用於生成文檔的配置文件(按照格式修改)
在這裏插入圖片描述
docfx docfx_project\docfx.json --serve:生成API文檔
在這裏插入圖片描述
現在可以通過http://localhost:8080/api/去查看文檔
在這裏插入圖片描述

如果未使用端口8080,docfx則將_site在下託管http://localhost:8080。如果8080正在使用,則可以使用docfx serve _site -p 更改要使用的端口docfx。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章