将帮助集成到 Visual Studio .NET

• 下载 VS.NET 帮助集成器 - 35 Kb

引言

在任何规模的项目上工作时，我们都知道良好的文档有多么重要。但编写文档是另一回事。

C# 和 Microsoft .NET Framework 已经采取措施来帮助您解决这个问题。引入了一个 XML 文档标准，您可以直接将其写入源代码中，就像 Java 的 Javadoc 一样。

在本文中，我将解释如何使用 XML 标签进行文档编写，如何使用 NDoc 将 XML 转换为非常漂亮的 HTML 帮助文件，以及最后但并非最不重要的一点，如何将帮助集成到 Visual Studio .NET 中。

必备组件

在开始编写文档之前，您将需要一些程序，这些程序都可以免费下载

• NDoc
• H2Reg
• Visual Studio .NET 帮助集成工具包

我不会解释如何安装这些程序，它们几乎都是完全自动安装的。安装完所有这些之后，您应该就可以开始创建漂亮的文档了，这些文档将作为动态帮助和智能感知直接在 Visual Studio 中可用。

实际的注释

您的源代码的实际注释在此优秀文章中进行了说明：C# 文档和注释。

生成 NDoc 文档时，您需要使用 HtmlHelp2 格式。

使用 H2Reg 将文档集成到 VS.NET 中

通常，您需要使用 .msi 安装脚本安装帮助文件。在这种情况下，这实在太麻烦了。幸运的是，Helpware 制作了一个名为 H2Reg 的小型实用程序，可以为我们做到这一点。它需要一个配置文件，并且必须从命令行调用，所以我认为一个小型的辅助程序可以使它更容易。本文顶部有一个下载链接。

您现在所需要做的就是填写字段并按生成。该程序将在您的项目目录中创建一个名为Help 的目录，其中将包含配置文件，以及两个批处理文件，您可以使用它们来注册和注销 Visual Studio .NET 中的帮助文件

您可以在项目目录的 ./doc 目录中找到帮助集合文件（如果您没有更改默认的 NDoc 目录，则为）。

该程序将在一个名为 Help 的目录中生成文件，该目录比 NDoc 目录高一级。生成文件后，您只需运行 register.bat 批处理文件即可在 Visual Studio .NET 中注册您的帮助文件。

如果您在注册集合时遇到问题，请查看 H2Reg 的日志文件，名为 C:\Program Files\Helpware\H2Reg\H2Reg_Log.txt（假设您将其安装在默认目录中）。

将帮助包含到 Visual Studio .NET 中

帮助文件现在已激活并集成到 Visual Studio 帮助集合中。如果 Visual Studio .NET 正在运行，您可能需要重新启动它。

现在我们有了上下文相关的帮助、智能感知和动态帮助

结论

只需几个简单的步骤，我们就可以为自己的代码集成帮助，几乎随处可见。

对我来说，这确实是一个提高生产力的工具。你呢？

修订历史

• 2004 年 1 月 18 日：更新了新程序和使用 HtmlHelp2 的说明。
• 2004 年 1 月 22 日：更新了程序以自动注册到 Visual Studio 的帮助集合中，并更新了文章以反映它。