Sandcastle----強大的C#文檔生成工具

最近客戶索要産品的二次開發類庫文檔,由于開發過程中并沒有考慮過此類文檔,而且項目規範比較，持續時間比較長，經手人比較多，還真是麻煩,如果人工制作文檔需要是一個比較大的工程.還好有這個文檔生成工具,能夠根據項目生成文檔,而且格式看起來确實很專業.

     Sandcastle是微軟官方的文檔生成工具，NDoc開發停止後，這個貌似也是唯一的一個這方面的工具。它從dll檔案及其xml注釋檔案能夠生成完整的幫助文檔，支援多種生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),結合新釋出的Sandcastle Help File Builder可視化工具，整個生成過程十分簡單，而且SHFB工具看起來很強大，不僅能夠直接配置生成文檔的各個屬性，而且還支援很靈活的擴充設定，為我們提供完美的.NET類庫文檔成為一個可能。

      來一步一步的看下整個生成過程:

     3.安裝完成後直接建立項目，主視窗會直接打開項目屬性，這裡就是對生成文檔的主要配置區域。我們先添加需要生成文檔的源。右擊項目中的Documentation Sources可以添加多種檔案類型（sln,proj,xml,dll,exe) 

     4.對主要的屬性進行設定.

       FrameworkVersion:  選擇對應的Framework版本

       HelpFileFormat :  選擇需要生成的文檔的格式. 注意這裡標明的格式要在下面對應的地方進行設定.

      NamespaceSummaries:  選擇需要生成的命名空間，直接點選開窗選擇。這可強大多了，之前用指令行或者其它工具都是要手動輸入。

      Lanugages ：語言一定要選擇中文，這會使一些文檔裡的一些文字自動生成中文

      CopyrightHref:版權連結

      CopyrightText: 版權文字

      HelpTitle: 文檔标題

      HtmlHelpName:文檔生成檔案名稱

      PresentationStyle: 這裡現在支援vs 2005,Prototype等格式 ，根據自己需要選擇

      OutputPath:生成路徑

      Show Missing Tags:下面的一些設定根據需要在最終版生成時設定成True,不然會在文檔中出現紅色的提示.

    設定完成的界面如下:

      5.點選上面的生成菜單或者按鈕，就可以直接打開生成過程界面，在這裡可以直接檢視生成過程中的一些提示和錯誤.生成完成後，一個和MSDN風格一緻的文檔就出來了:

     6. 而且支援在文檔中插入圖檔，插入代碼等功能。

     7.代碼規範是最根本的前提，一定要在代碼中提加足夠的注釋。

資源: 

          用Sandcastle和Help Integration Wizard把文檔內建到Visual Studio   

本文版權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接配接，否則保留追究法律責任的權利。

本文轉自孤獨俠客部落格園部落格，原文連結：http://www.cnblogs.com/lonely7345/archive/2010/01/13/1647245.html，如需轉載請自行聯系原作者