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

2022-01-10 01:09:32 字數 896 閱讀 7868

微軟放棄sandcastle有些年頭了,微軟最近開源了全新的文件生成工具docfx,目前支援c#和vb,類似jsdoc或sphinx,可以從源**中提取注釋生成文件之外,而且還有語法支援你加入其他的檔案鏈結到api新增額外的說明,docfx會掃瞄你的源**和附加的檔案為你生成乙個完整的html模版**,你可以自己通過模版定製,目前已經內嵌了幾個模版,包括靜態的html頁面和angularjs頁面。你還可以自己定製模版,具體參考 how to create custom template。

源**:

文件:

在docfx中,最重要的就是生成文件,把markdown檔案(gfm語法)轉換成html,微軟還開源乙個基於gfm的並且很容易擴充套件的語法的markdown元件 markdownlite,**包含在docfx,nuget庫里包的名字是microsoft.docascode.markdownlite。
有一篇文件詳細介紹了如何使用docfx: getting started with docfx,具體怎麼使用請看這篇文章, 這裡還有個openlivewriter的例子 use docfx to auto-generate documents for olw。
faq:

q: docfx是什麼?

a: docfx是乙個api文件編譯軟體,它能根據c#/vb源**生成對應的文件元資料並生成文件(目前提供html),並支援普通md檔案。

q: docfx的輸入和輸出是什麼?

a: docfx metadata需要源**來生成文件元資料,docfx build使用文件元資料+普通md檔案生成文件(html)

q: docfx支援定製模板麼?

a: 是的,可以參考文件

q: docfx跨平台麼?

a: docfx支援在dnx下執行。

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

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

再談Doxygen 乙個開源文件生成工具

介紹 doxygen是乙個開源文件生成工具,通過使用doxygen可以將c 檔案中的注釋檔案生成html或者latex等格式的文件。詳細介紹 在 中輸入doxygen,一大堆介紹。doxygen 的官方主頁是 doxygen 使用的畫出各種圖形的第三方工具是 at t 實驗室的 graphviz 這...

使用微軟的工具生成證書

一,使用微軟的工具不採用私鑰檔案 1.製作根證書 makecert sk mypk ss myssname n cn 公司名稱 r myroot.cer sk 表示主題的金鑰容器位置,ss 主題的證書儲存名稱,n 證書頒發物件,r 證書儲存位置 2.製作子證書 makecert sk mypk is...