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

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帮助v1.0/1.1文件(CHM)或v2.0 (集成到Visual Studio帮助中)。实际的API开发团队使用它(或其变体)来为BCL创建.NET文档，因此您应该对它的功能有所了解。当然，我不确定您想要的文档的确切性质，但Sandcastle可以用于生成API文档和附带的帮助页面(指南、教程、示例、白皮书、词汇表等)。使用它的自定义MAML (类XML )标记语言，这实际上就是在代码中的XML注释中使用的标记语言。

Here是沙堡入门的基本指南，但我怀疑您只需要尝试一下它就能理解它。学习曲线也不是特别陡峭，除非您坚持从命令行学习。到目前为止，最简单的选择是使用Sandcastle Help File Builder GUI，这是一个非常棒的工具，完全不会限制您。

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