Sandcastle Help File Builder相信很多的園友用過，小弟我最近因為工作原因需要生成公司的一套SDK的幫助文檔，因此找了一些資料，發(fā)現(xiàn)網(wǎng)上的資料很多，但是都不怎么完全，有些只是隨便寫了一些類，生成一個幫助文檔。沒有整體性，因此在這里將我的一些步驟貼出來，供大家討論。Sandcastle是微軟提供的一個根據(jù)XML注釋和DLL文件生成幫助文件的工具，目前是在CodePlex上的一個開源項目，可以去這里下載：Sandcatle 項目，Sandcastle 本身是一個console的程序，為了方便使用，我們可以使用他的GUI版本：Sandcastle Help File Builder。

首先 環(huán)境準備，我這里是要生成.CHM格式的文檔，因此需要一些軟件來生成，軟件下載。

1.首先安裝htmlhelp.exe,然后安裝Sandcastle.msi，最后解壓SHFBGuidedInstallation_1930，安裝SandcastleInstaller.exe，按照提示，一步一步安裝完成。安裝完成后

2.現(xiàn)在基本環(huán)境已經(jīng)搭建好了，下面是要生成的項目的設(shè)置了，找到你要生成的項目，右鍵屬性--生成，在XML文檔前面打鉤

3.生成所有要生成的項目，注意生成的項目一般都應(yīng)為dll類型，即類庫。
4.打開Sandcastle Help File Builder，點擊菜單項 file--new project，新建一個項目，下面就是項目的詳細的設(shè)置了。首先添加要生成文檔的dll和xml注釋文檔，找到右上方文件源和引用，文件源是指你要生成的dll和xml注釋文檔，引用是指你的dll的依賴項，比如你的dll引用了第三方的.net組件，或者你的dll引用了一些c或者c++的文件，都需要添加到引用。我們這套組件引用了一些自己編寫的c文件。因此需要添加到此處。

5.添加完文件后就是一些主要的詳細的設(shè)置了。
Build項下：
BuildLogFile：日志的路徑
CleanIntermediates：如果true，生成項目時，上個項目生成的文件會刪除。
FrameworkVersion：.NET WORK 的版本。
HelpFileFormat：幫助文檔的形式，HtmlHelp1是值.chm的格式文件，這里我們設(shè)置此格式。還有msdn的格式可以設(shè)置。
Comments項：
NamespaceSummaries：命名空間說明，點擊進入后會彈出所有的項目，你可以給所有的項目加上說明

Help File項



結(jié)果：

總結(jié)

以上是生活随笔為你收集整理的Sandcastle Help File Builder使用教程的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。