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

     最近客戶索要產品的二次開發類庫文檔,由于開發過程中并沒有考慮過此類文檔,而且項目規范比較，持續時間比較長，經手人比較多，還真是麻煩,如果人工制作文檔需要是一個比較大的工程.還好有這個文檔生成工具,能夠根據項目生成文檔,而且格式看起來確實很專業.
     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.rzrgm.cn/fox23/archive/2008/09/09/using-sandcastle-integrated-help-documents-into-visual-studio.html

 

 

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