四種Sandcastle方法生成c#.net幫助類幫助文檔

 方法1、Visual Studio新建documentation生成幫助文檔

        前段時間在網上收集和本身平時工做總結整理了《乾貨,比較全面的c#.net公共幫助類》，整理完成上傳github以後我又想，既然是幫助類，總得有個幫助文檔因而乎想到了Sandcastle，Sandcastle是微軟官方生成幫助文檔這發麪的工具。

       它能夠配合Microsoft Visual Studio生成的dll和xml註釋文件生成完整的幫助文檔。

       結合可視化工具Sandcastle Help File Builder，簡單直接，還能生成各類屬性的說明。

       支持Helpe1x:chm, Helper2x:Hxs, Website,HelperView等多種格式並且擴展靈活功能強大，下面咱們就看一下怎樣用Sandcastle生成chm文檔。

   1、下載

     首先咱們前往CodePlex下載Sandcastle，地址:http://sandcastle.codeplex.com/

     而後下載Sandcastle Help File Builder，地址：http://shfb.codeplex.com/，點擊右邊download下載便可。

2、安裝

      Sandcastle，直接Next就能夠了，Sandcastle Help File Builder要說一下的是，在MAML Schema IntelliSense for Visual Studio爲vs安裝插件的時候必定要勾選上，否則新建項目的時候會沒有這個選項。

3、設置

    在生成這裏設置xml文檔文件，保存，編譯以後在你項目目錄的bin\Debug就會看到生成的xml文件了。

4、新建項目documentation

    首先 新建documentation項目，這裏就是安裝Sandcastle Help File Builder的時候勾選上vs的緣由。若是沒有勾選上，這裏新建的時候沒有這個選項的。

    

 而後勾選上你剛纔已經生成的dll和xml文件，右鍵屬性如上圖寫上標題。編譯生成便可。這裏有一點要注意，可能會報錯（SHFB: Error BE0037: Could not find the path the the HTML Help 1 compiler. See the error number topic in the help file for details.），是沒有安裝Microsoft HTML Help，固然你安裝了以後能夠跳過此步驟。

若是沒有安裝Microsoft HTML Help，咱們到https://www.microsoft.com/en-us/download/details.aspx?id=21138去下載Microsoft HTML Help而後安裝。

5、生成

若是沒有報錯，直接生成，而後咱們項目目錄的Help就能夠看到生成的幫助文檔了

     是否是很簡單。這樣咱們就生成了以前幫助類的幫助文檔了。另外我再介紹幾種生成幫助文檔的方式。

回到頂部(go to top)

方法2、cmd生成幫助文檔

在Sandcastle和Sandcastle Help File Builder都安裝好的前提下，

在咱們將步驟三生成的Common.Utility.dll 和Common.Utility.xml 拷貝至C:\Program Files (x86)\Sandcastle\Examples\Sandcastle（Sandcastle安裝路徑）下面。

這種方法是一種批處理的方法,而後咱們打開cmd,輸入build_sandcastle.bat vs2005 Common.Utility 回車，而後進行批處理。

咱們會看到這目錄下生成不少文件夾，若是過程沒有報錯，咱們在chm 文件夾就會看到咱們生成的幫助文檔了。

回到頂部(go to top)

方法3、SandcastleBuilderGUI

咱們根據上面的設置，而後引入Common.Utility.dll 和Common.Utility.xml，生成便可。相關設置參考：http://www.cnblogs.com/lonely7345/archive/2010/01/13/1647245.html

回到頂部(go to top)

方法4、Sandcastle Help File Builder可視化工具

經過Sandcastle的圖形操做界面。在C:\Program Files (x86)\Sandcastle\Examples\Generic\SandcastleGui.exe下打開以下界面。

根據圖上相關設置而後點擊Build按鈕。便可生成幫助文檔，是否是更方便簡潔。

固然前提是也是生成Common.Utility.dll 和Common.Utility.xml的狀況下面。

如上四種方法生成幫助文檔。至此c#.net幫助類告一段落。

 

本文來自：http://www.cnblogs.com/anyushengcms/p/7682501.html