一、前言
在多人協作的項目中，除了良好的代碼規範外，完整的api文檔也相當重要。通過文檔我們快速了解系統各子產品的實際接口，及其使用場景、使用示例，一定程度上降低溝通成本，和減少後期維護中知識遺失等風險。
對于.net，我們可以直接将類、方法等的注釋直接轉為api文檔，極大地減少文檔維護的工作量，同時也能反向提高大家的注釋品質。
下面我們使用.net唯一的注釋生成api文檔工具——sandcastle和sandcastle help file builder來實作api文檔自動化吧！
二、工具
三、從注釋到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://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