程式設計
如果專案要作系統文件交接的時候,可以考慮使用這套工具
先從nuget安裝docfx.console (註:原名是docfx.msbuild)
安裝後套件管理器主控台,移到有docfx.json的目錄,輸入docfx後就會自動執行了
也可以直接用visual studio的建置功能,也會自動生成文件
執行完,會產生一個_site的資料夾,裡面就會有說明文件
如果放在IIS上跑,輸入 ://localhost/_site/,選擇API Document即可
若沒有放在IIS上,直接用網頁開啟,某些元件會跑不太起來不好看
當然,說明的內容還是得靠編寫程式時自行輸入註解
在每個方法(method)前面輸入三個註解符號,C#是///,vb是''',就會產生可填寫註解的區塊
開發好好寫,回頭就輕鬆多了
要注意一點,每次建置的時候,docfx.json會去檢查.csproj裡面所有檔案,因此建置過程會比較緩慢
我這邊的做法是改成加上一個.stop的副檔名讓他找不到檔案,等到真的要建立的時候再改回來
參考資料
http://www.kangting.tw/2016/04/visual-studio-docfx.html
https://kiritorastorehouse.wordpress.com/2016/01/30/docfx/