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

     最近客戶索要產品的二次開發類庫文檔,由於開發過程中並沒有考慮過此類文檔,而且項目規範比較，期間比較長，經手人比較多，還真是麻煩,如果人工製作文檔需要是一個比較大的工程.還好有這個文檔產生工具,能夠根據項目產生文檔,而且格式看起來確實很專業.
     Sandcastle是微軟官方的文檔產生工具，NDoc開發停止後，這個貌似也是唯一的一個這方面的工具。它從dll檔案及其xml注釋檔案能夠產生完整的協助文檔，支援多種產生格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),結合新發布的Sandcastle Help File Builder視覺化檢視，整個產生過程十分簡單，而且SHFB工具看起來很強大，不僅能夠直接配置產生文檔的各個屬性，而且還支援很靈活的擴充設定，為我們提供完美的.NET類庫文檔成為一個可能。
      來一步一步的看下整個產生過程:

     1.從這裡下載最新的Sandcastle後安裝.
     2.從這裡下載今年才發布的Sandcastle Help File Builder.
     3.安裝完成後直接建立項目，主視窗會直接開啟項目屬性，這裡就是對產生文檔的主要配置地區。我們先添加需要產生文檔的源。右擊項目中的Documentation Sources可以添加多種檔案類型（sln,proj,xml,dll,exe) 
     4.對主要的屬性進行設定.
       FrameworkVersion:  選擇對應的Framework版本
       HelpFileFormat :  選擇需要產生的文檔的格式. 注意這裡選定的格式要在下面對應的地方進行設定.
                              注意對於不同的格式還需要安裝不同的編譯工具 Helpe1x(chm)需要安裝Microsoft HTML Help,Helper2x(Hxs)需要安裝 Hxcomp.
      NamespaceSummaries:  選擇需要產生的命名空間，直接點擊開窗選擇。這可強大多了，之前用命令列或者其它工具都是要手動輸入。
      Lanugages ：語言一定要選擇中文，這會使一些文檔裡的一些文字自動產生中文
      CopyrightHref:著作權連結
      CopyrightText: 著作權文字
      HelpTitle: 文檔標題
      HtmlHelpName:文檔組建檔案名稱
      PresentationStyle: 這裡現在支援vs 2005,Prototype等格式 ，根據自己需要選擇
      OutputPath:產生路徑
      Show Missing Tags:下面的一些設定根據需要在最終版產生時設定成True,不然會在文檔中出現紅色的提示.
    設定完成的介面如下:
      

      5.點擊上面的產生菜單或者按鈕，就可以直接開啟產生過程介面，在這裡可以直接查看產生過程中的一些提示和錯誤.產生完成後，一個和MSDN風格一致的文檔就出來了:
        
    
     6. 而且支援在文檔中插入圖片，插入代碼等功能。
     7.代碼規範是最根本的前提，一定要在代碼中提加足夠的注釋。

資源: 
          Sandcastle Help File Builder：    http://shfb.codeplex.com/
          SandcastleGUI：http://www.inchl.nl/SandcastleGUI/ 之前一直使用的另外一個Sandcastle產生工具
          用Sandcastle和Help Integration Wizard把文檔整合到Visual Studio   
           http://www.cnblogs.com/fox23/archive/2008/09/09/using-sandcastle-integrated-help-documents-into-visual-studio.html

 

 

作者：孤獨俠客（似水流年）
出處：http://lonely7345.cnblogs.com/
本文著作權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文串連，否則保留追究法律責任的權利。