.Net魔法堂：提取註釋生成API文檔

1、前言　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

  在多人協做的項目中，除了良好的代碼規範外，完整的API文檔也至關重要。經過文檔咱們快速瞭解系統各模塊的實際接口，及其使用場景、使用示例，必定程度上下降溝通成本，和減小後期維護中知識遺失等風險。

  對於.Net，咱們能夠直接將類、方法等的註釋直接轉爲API文檔，極大地減小文檔維護的工做量，同時也能反向提升你們的註釋質量。

  下面咱們使用.Net惟一的註釋生成API文檔工具——Sandcastle和Sandcastle Help File Builder來實現API文檔自動化吧！

 

2、工具　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

  Sandcastle： http://sandcastle.codeplex.com/

  Sandcastle Help File Builder：http://shfb.codeplex.com/

 

3、從註釋到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文檔了。

 

4、總結　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

  上述僅介紹了Sandcastle Help File Builder的部分功能，往後將逐漸補充。

  尊重原創，轉載請註明來自：http://www.cnblogs.com/fsjohnhuang/p/3968313.html  ^_^肥仔John

 

5、參考　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　

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