docfx （一）

什麼是docFX?

DocFX 是一個基於.NET的API文檔生成器，當前支持 C# 和 VB。
它能夠經過你的代碼中的三斜槓註釋生成 API 參考文檔。一樣也支持你使用 Markdown 文件建立一些其餘的主題文檔（例如：教程以及使用手冊）。以及自定義生成的參考文檔。
DocFX 會使用你的代碼以及 Markdown 文件生成一個靜態的 HTML 網站。你能夠將它輕鬆的部署到任何web 服務器（例如： github.io）。一樣的 DocFX 也提供擴展性，容許你經過模版自定義網站的佈局和樣式.

 

特性

• 和你的代碼緊密集成。你能夠在文檔中點擊 "View Source" 連接導航到github上對應的源代碼(你的代碼必須發佈到 GitHub )。
• 跨平臺的支持。擁有Windows平臺以及.NET Core 的跨平臺 exe程序。
• 和Visual Studio集成. 你能夠在Visual Studio 中無縫使用 DocFX 。
• Markdown 擴展。咱們推薦DocFX Flavored Markdown(DFM) 格式來編寫文檔。 DFM 100% 兼容 GitHub Flavored Markdown(GFM) 而且添加了一些有用的擴展,例如 file inclusion（ 文件包含）, code snippet（ 代碼片斷）, cross reference（ 交叉引用）, 以及 yaml header。

安裝docFX

DocFX ships as a chocolatey package. Install docfx through Chocolatey by calling cinst docfx -y.

翻譯一下： DocFX 被打包成 chocolatey 包.能夠經過 Chocolatey 調用命令 cinst docfx -y 來安裝。(這種安裝方法俺不會，說的太模糊)。
官網還有一種方法

you can download and unzip docfx.zip from https://github.com/dotnet/docfx/releases, extract it to a local folder, and add it to PATH so you can run it anywhere.

這個方法還行吧，我就用的這個可是我去這個網址下載這個文件下了好幾回才成功，也不知道爲啥，最後我越獄下載就成功了。

下載成功就解壓唄，而後運行 docfx.exe文件，立馬彈出一個命令窗口，而後就立馬消失。靠我試了好幾遍 都是這個樣的，有沒有搞錯，浪費了我很多時間。

最後我決定把這個程序加載到 環境變量中去，cmd運行 ，ok了 ，安裝成功。