VS文檔自動生成

VS2008文檔自動生成

(發現，Sandcastle主要是用於C#項目。裏面的註釋都是XML格式的。不太適合VC的。最終仍是得用Doxygen)

1、Sandcastle簡介：

Sandcastle(CodeName)是微軟出的用於編譯發佈組件（Assembly）信息的一個工具，其前身爲發佈VS2005以前，MS內部開發了一個用於生成幫助文檔的工具。

2、Sandcastle與NDoc的簡單比較：

NDoc是.Net2003下的文檔生成工具，它是一個開源的東東。目前已經中止開發，最新版本不支持2.0。

它們都是經過反射和Xslt技術，從dll文件及其註釋（編譯時加/doc參數獲得）中獲得一個完整的幫助文檔，文檔格式能夠是html或chm甚至是任何自定義的格式。

當前Sandcastle最新版本是June CTP，使用的方式仍然是命令行，不提供GUI支持；並且官方網站上給出的使用說明：其只能支持單一的dll，對於Solution仍然沒有任何說明。

3、如何利用Sandcastle自動生成.NET2.0開發幫助文檔

A．軟件安裝準備工做：(下載網站：http://shfb.codeplex.com/）

一、 必備軟件：HtmlHelpWorkshop.exe 網上處處都有；若是本機已經安裝就無需理會；

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

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

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

             先安裝Sandcastle_2710.msi；

            後安裝SandcastleHelpFileBuilder_1950.msi

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

 

       使用步驟：

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

        二、見AA工程以下圖

                 

 

        三、點擊「右邊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.163.com/qimo601@126/blog/static/15822093201211129328968/