一、前言
在多人協作的項目中，除了良好的代碼規范外，完整的API文檔也相當重要。通過文檔我們快速了解系統各模塊的實際接口，及其使用場景、使用示例，一定程度上降低溝通成本，和減少后期維護中知識遺失等風險。
對於.Net，我們可以直接將類、方法等的注釋直接轉為API文檔，極大地減少文檔維護的工作量，同時也能反向提高大家的注釋質量。
下面我們使用.Net唯一的注釋生成API文檔工具——Sandcastle和Sandcastle Help File Builder來實現API文檔自動化吧！
二、工具
Sandcastle： http://sandcastle.codeplex.com/
Sandcastle Help File Builder：http://shfb.codeplex.com/
三、從注釋到API文檔
1. 生成XML文檔文件
步驟：1. 在VS中，右擊程序集->選擇“屬性”->選擇“生成”頁->勾選“XML文檔文件”
2. 編譯程序集后，在生成目錄下可以找到“程序集名稱.XML”文件。
2. 使用SandcastleBuilderGUI.exe生成API文檔
安裝工具Sandcastle和Sandcastle Help File Builder后，點擊SandcastleBuilderGUI.exe即可進入文檔生成項目的界面。
步驟：1. 配置文檔基本信息：點擊“Help File”頁
按照上圖，依次配置文檔標題，文檔名稱，文檔語言，文檔風格。
2. 將程序集DLL和XML文件加載到文檔生成項目中。
右擊“Documentation Sources”，選擇“Add Documentation Sources”，然后將程序集DLL和XML添加進來即可。
3. 生成API文檔
點擊菜單欄的“Documentation”->“Build Project”即可，此時只需到Sandcastle Help File Builder.exe所在的目錄即可找到API文檔了。
四、總結
上述僅介紹了Sandcastle Help File Builder的部分功能，日后將逐漸補充。
尊重原創，轉載請注明來自：http://www.cnblogs.com/fsjohnhuang/p/3968313.html ^_^肥仔John
五、參考
http://guojun2sq.blog.163.com/blog/static/643308612010116394430/
http://www.boyd.cn/info_Show.asp?ArticleID=4945
http://blog.csdn.net/chtnj/article/details/8278342
http://blog.csdn.net/chtnj/article/details/8278360