DocFX生成API文件

2022-03-13 23:24:39 字數 287 閱讀 2250

弄了個開源專案

unity shader graph中英文對照api

採用docfx對markdown文件進行生成

docfx 簡單使用方法、自動生成目錄的工具:

使用docfx 建立屬於你的github 文件頁面:

當然如果你希望本地看**,windows使用者需要自行配置iss,然後新增**,選擇_site這個資料夾

bat命令

1.重新生成:

cmd /k docfx docfx.json

2.使用本地谷歌開啟**(埠自改)

微軟開源全新的文件生成工具DocFX

微軟放棄sandcastle有些年頭了,微軟最近開源了全新的文件生成工具docfx,目前支援c 和vb,類似jsdoc或sphinx,可以從源 中提取注釋生成文件之外,而且還有語法支援你加入其他的檔案鏈結到api新增額外的說明,docfx會掃瞄你的源 和附加的檔案為你生成乙個完整的html模版 你可...

微軟開源全新的文件生成工具DocFX

微軟放棄sandcastle有些年頭了,微軟最近開源了全新的文件生成工具docfx,目前支援c 和vb,類似jsdoc或sphinx,可以從源 中提取注釋生成文件之外,而且還有語法支援你加入其他的檔案鏈結到api新增額外的說明,docfx會掃瞄你的源 和附加的檔案為你生成乙個完整的html模版 你可...

apiDoc 生成api文件

安裝node.js 安裝apidoc npm install apidoc g在你的專案根目錄下新建apidoc.json檔案,該檔案描述了專案對外提供介面的概要資訊如名稱 版本 描述 文件開啟時瀏覽器顯示標題和介面預設訪問位址。apidoc.json apidefine rknotfoundexc...