使用 SandCastle 工具为您的项目生成 .chm 文档

目录

1. 引言
2. 什么是 Sandcastle 工具？
3. 安装 Sandcastle 工具
4. 为您的项目生成 XML 文档
5. 在 Sandcastle GUI 中创建新项目
6. 在项目中添加文档资源
7. 构建您的 Sandcastle 项目
8. 为您的项目生成 .chm 帮助文件

引言

在产品开发完成后，我们需要进行最终交付。我们还需要提供与应用程序功能相关的文档集合、代码文档等。.Chm 文档一直是一个不错的选择。用户可以通过点击链接轻松地在不同部分之间导航。他们还能够搜索文件中的任何特定单词。市场上有很多工具可以轻松地从您的项目或已编译的程序集中生成 .chm 文档。我发现 Sandcastle 是最好的，因为它免费，并且由 Microsoft 自己开发，提供了很多功能。

什么是 Sandcastle 工具

这是 Microsoft 开发的一款工具，可在 sandcastle.codeplex.com 上免费获取。Sandcastle 通过反射源代码程序集并可选地集成 XML 文档注释，来生成准确、MSDN 风格、全面的文档。它为您的项目生成基于 .chm 文件的文档。

安装 Sandcastle 工具

1. 安装 Sandcastle 工具
2. 解压 **SHFBGuidedInstaller_1940** 文件并点击 **SandcastleInstaller.exe**，它将安装 Sandcastle 工具使用的基本组件。
3. 进入您解压的文件夹中的 **InstallResources** 文件夹。
4. 安装 **SandcastleHelpFileBuilder_1940.msi**
5. 这将把 SandCastle 帮助文件生成器 GUI 工具安装到 **C:\Program Files\EWSoftware\Sandcastle Help File Builder**。
6. 现在您已准备好所有东西。

为您的项目生成 XML 文档

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

在 Sandcastle GUI 中创建新项目

1. 转到 **C:\Program Files\EWSoftware\Sandcastle Help File Builder** 并点击 **SandcastleBuilderGUI.exe**。
2. 点击文件，然后点击新建项目。
3. 给您的项目命名，并将其保存在任何您想要的位置（创建新项目时，它会询问您项目的名称和保存位置）。
4. 您的项目已准备就绪。

在项目中添加文档资源

1. 右键单击文档资源。
2. 点击添加文档资源。
3. 导航到您的项目 bin 文件夹（Visual Studio 项目的 bin 文件夹）。
4. 选择您项目的 dll 文件和 XML 文件。

1. 点击打开，这些文件将被添加到 **文档资源** 下。
2. 选择项目的基本属性，例如 .chm 帮助文件的页眉和页脚文本。
3. 修改帮助标题、CopyrightText、CopyRightHref、FeedbackEmail 地址等，您可以根据需要设置许多其他属性。

构建您的 Sandcastle 项目项目。

1. 现在按 Ctrl+Shift+B 构建您的项目。
2. 构建项目将需要一些时间。

为您的项目生成 .chm 帮助文件。

1. 构建完成后。
2. 您需要导航到保存 Sandcastle 项目的文件夹。
3. 导航到帮助文件夹。
4. 点击帮助文件。
5. 您的基于 chm 的文档已准备就绪。

摘要

通过本文，您已经了解了如何借助 SandCastle 工具轻松生成产品文档。尝试一下，它将为您节省大量生成文档所需的时间。