为我的应用程序制作帮助文件

Question

我正在研究一个遗留应用程序，我实际上是在C＃.NET中从头开始重写它。 它曾经使用WinHelp为用户提供某种帮助，但Vista（我正在开发的系统）说它不支持WinHelp。所以我要问的是：

如何使用C＃.NET创建类似的系统？我希望在Vista，XP和以前的Windows版本中使用新功能。

Answer 1

使用CHM文件而不是几乎弃用的WinHelp文件。您可以使用HTML Help Workshop创建这些文件。

Answer 2

您可以尝试Help & Manual。这是一个很棒的工具。

Answer 3

您现在真的想要研究使用Microsoft Sandcastle文档生成器。它完全能够生成HTML Help v1.0 / 1.1文件（CHM）或v2.0（用于集成到Visual Studio帮助中）。实际的.NET Framework开发团队使用它（或其变体）来为BCL创建API文档，因此您应该了解它的功能。我当然不确定您的文档的确切性质，但Sandcastle可用于生成API文档和随附的帮助页面（指南，教程，示例，白皮书，词汇表等）。 ）使用其自定义MAML（类似XML）标记语言，这基本上是在代码中的XML注释中使用的。

Here是开始使用Sandcastle的基本指南，但我怀疑你只需要稍微了解它就可以理解它。学习曲线也不是特别陡峭，除非你坚持从命令行学习它。到目前为止最简单的选择是使用Sandcastle Help File Builder GUI，这是一流的工具，并不会限制你。

另一个有用的资源是this C# XML Documentation guide，它向您展示了如何使用XML注释正确地记录您的API，这些注释可以转换为CHM文档以及IntelliSense。