.NET項目工程生成一份項目幫助文檔chm

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

      一、下載該軟件，網址：http://shfb.codeplex.com/；

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

      二、開始安裝，須要裝兩個軟件（最好默認安裝到C:\下）

             先安裝Sandcastle_Jun_2010.msi；

            後安裝SandcastleHelpFileBuilder_1930.msi

      三、安裝完畢後，在程序中能夠找到「Sandcastle Help File Builder GUI」執行文件，運行：（裏面已經新建了一個工程-7）

         

       使用步驟：

        一、點擊「File」--> New Project -->彈出對話框，輸入工程名稱，好比：AA，點擊保存

        二、見AA工程以下圖：

         

        三、

              選擇項目屬性-勾選xml文檔文件。

 

             點擊「右邊AA」下面「Documentation Source」，點擊右鍵Add，選擇咱們開發項目已經編譯好的dll和xml文件（注意：項目編譯                  必須輸出 xml文件，方法見下面解說）

        四、配置相關屬性；

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

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

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

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

                   ⑤、HelpFileFormat      ---   選擇HtmlHelp1

                   ⑥、Language               ---   默認選中「英語（美國）」

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

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

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

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

                   其餘屬性可默認....

          五、點擊「Bulid the help file」按鈕進行編譯操做，

                 

 

 解說：項目生成輸出xml文件操做---》點擊項目屬性，彈出對話---生成--勾選中 輸出XML文檔文件，下次編譯便可輸出xml文件    

 

 

轉載自http://blog.csdn.net/w3031213101/article/details/6659739