使用Sandcastle工具生成项目文档

在产品开发完成后，需要提供最终交付物。同时，还需要提供与应用程序特性、代码文档等相关的文档集合。基于.chm的文档一直是一个很好的选择。用户可以轻松地通过点击链接从一个部分导航到另一个部分。他/她还可以在文件中搜索任何特定单词。市场上有多种工具可以轻松地从项目或编译的程序集中生成基于.chm的文档。发现Sandcastle是最好的，因为它是免费的，由微软开发，并提供许多功能。

什么是Sandcastle工具

这是微软创建的工具，可以在上免费获取。Sandcastle通过反射源程序集并可选地集成XML文档注释，生成准确、MSDN风格的全面文档。它为项目生成基于.chm文件的文档。

安装Sandcastle工具

首先从下载Sandcastle工具，并从下载Sand Castle帮助文件构建器。

安装Sandcastle工具：

1. 解压缩并运行SHFBGuidedInstaller_1940文件中的SandcastleInstaller.exe，它将安装Sandcastle工具使用的基本组件。
2. 转到解压缩的文件夹中的InstallResources文件夹。
3. 安装SandcastleHelpFileBuilder_1940.msi，它将在C:\Program Files\EWSoftware\Sandcastle Help File Builder中安装SandCastle帮助文件构建器GUI工具。

现在已经准备好了一切。

生成项目的XML文档

现在需要为项目生成基于XML的文档。这非常简单，请按照以下步骤操作：

1. 右键单击项目，选择属性。
2. 点击构建=>勾选XML文档文件。
3. 保存项目。
4. 构建项目，将在bin文件夹中找到XML文档文件。
5. 关闭解决方案。

在Sandcastle GUI中创建新项目

步骤：

1. 转到C:\Program Files\EWSoftware\Sandcastle Help File Builder并点击SandcastleBuilderGUI.exe。
2. 点击文件，然后选择新建项目。
3. 为项目命名并保存在任何所需位置（创建新项目时，它会询问保存项目的名称和位置）。

现在已经准备好了项目。

向项目添加文档资源

右键单击文档资源，点击添加文档资源，导航到项目bin文件夹（Visual Studio项目的bin文件夹），选择项目的dll文件和XML文件，点击打开，它们将被添加到文档资源下。

选择项目的基本属性，如.chm帮助文件的页眉和页脚文本，修改帮助标题、版权文本、版权链接、反馈电子邮件地址等，可以根据需要设置许多其他属性。

构建Sandcastle项目

现在按Ctrl+Shift+B构建项目。构建项目需要一些时间。