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

Question

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

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

Answer 1

使用CHM文件而不是几乎不推荐使用的WinHelp文件。 您可以使用HTML帮助工作室来创建这些文件。

Answer 2

您可以尝试“ 帮助和手册” 。 这是一个很棒的工具。

Answer 3

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

这是Sandcastle入门的基本指南，但我怀疑您只需要对其进行一些了解即可。 学习曲线也不是特别陡峭，除非您坚持要从命令行学习它。 到目前为止，最简单的选择是使用Sandcastle帮助文件构建器GUI ，它是一流的工具，完全没有限制。

另一个有用的资源是本C＃XML文档指南 ，该指南向您展示如何使用XML注释正确地记录API，这些注释可以转换为CHM文档和IntelliSense。