快速產生.NET Library說明文件

最近陷入地獄文件月,為了快速產生說明文件,

我將所有Code補上Summary,接下來就交給SANDCASTLE代勞了。

我個人開發專案時,所有相關文件永遠都是最後一哩路,

這篇簡單介紹如何使用SANDCASTLE快速產生.NET Library說明文件。

 

假設你所有Code都已經寫好完整Summary

1.設定專案建置輸出XML

2.下載Sandcastle Help File Builder

解壓縮後,執行SandcastleInstaller.exe會協助安裝相關所需軟體。

Ps:安裝過程很簡單,就不貼圖了。

 

3.執行Sandcastle Help File Builder GUI

4.執行New Project並載入Xml

會自動加入相關dll。

 

依個人需求設定

建置結果

參考

Sandcastle Help File Builder

CREATING HTML DOCUMENTATION IN C# USING VISUAL STUDIO AND SANDCASTLE

Creating documentation in C# using Visual Studio and Sandcastle