使用Sandcastle工具爲.NET項目工程生成一份項目幫助文檔chm

   Sandcastle的,由Microsoft創建的,是從創建MSDN風格的文檔中使用的工具。NET程序集和關聯的XML註釋文件。目前的版本是2010年6月發佈。這是命令行並沒有GUI前端,項目管理功能,或像,你可以找到在NDoc的自動生成過程。 Sandcastle的幫助文件生成器,填補空白,提供失蹤NDoc的樣是最常用的的功能,並提供基於圖形和命令行的工具,以建立一個自動化的方式幫助文件。

      必備軟件:HtmlHelpWorkshop.exe 網上到處都有;如果本機已經安裝就無需理會;

      下面介紹開始如何使用該軟件:

      1、下載該軟件,網址:http://shfb.codeplex.com/

             解壓找到文件夾InstallResources;可找到兩個安裝包Sandcastle_Jun_2010.msi;SandcastleHelpFileBuilder_1930.msi

      2、開始安裝,需要裝兩個軟件

    安裝  SandcastleInstaller.exe,把裏面所有的組件都安裝一遍。

      3、安裝完畢後,在程序中可以找到“Sandcastle Help File Builder GUI”執行文件,運行:(先新建了一個工程)

       使用步驟:

        1、點擊“File”--> New Project -->彈出對話框,輸入工程名稱,比如:NewDoc,點擊保存

        2、見NewDoc工程如下圖:

         

        3、點擊“右邊NewDoc”下面“Documentation Source”,點擊右鍵Add,選擇我們開發項目已經編譯好的dll和xml文件(注意:項目編譯必須輸出 xml文件,方法見下面解說)

        4、配置相關屬性;

                   ①、FrameworkVersion --- 選擇對應項目的.net版本(目前支持到4.0)

                   ②、ProjectSummary     ---  項目說明-編譯後的chm--Title屬性名稱

                   ③、HtmlHelpName       ---   輸出chm文件的名稱

                   ④、HelpTitle                  ---   文件標題說明

                   ⑤、HelpFileFormat      ---   選擇HtmlHelp1

                   ⑥、Language               ---   默認選中“英語(美國)”

                   ⑦、CopyrightText        ---   你的版權說明

                   ⑧、DocumentInheritedFrameworkMembers   ---- false    true<將屏蔽繼承過來的自帶的一些方法說明>

                   ⑨、DocumentInheritedMembers                       ---- false    true<將屏蔽繼承過來的自帶的一些方法說明>

                   ⑩、OutputPath            ---  輸出chm的文件夾

                   其他屬性可默認....


          5、點擊“Bulid the help file”按鈕進行編譯操作,

                 


 解說:項目生成輸出xml文件操作---》點擊項目屬性,彈出對話---生成--勾選中 輸出XML文檔文件,下次編譯即可輸出xml文件  

     

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章