哪些工具可用于在 Visual Studio 2010 中创建帮助文件？

Posted 2023-02-18

【中文标题】哪些工具可用于在 Visual Studio 2010 中创建帮助文件？

【英文标题】：What tools are available to create a help file in Visual Studio 2010?

【发布时间】：2011-03-05 21:02:29

【问题描述】：

我需要为 Visual Studio 2010 中的 WinForms 应用程序编写帮助文件。理想情况下，我希望使用与 Visual Studio 集成的工具，而不是完全独立的工具。

过去我使用过 html Help Workshop，但这是一个古老的工具，我记得它使用起来有点时髦。我也知道 Visual Studio 2005 SDK 中内置了一个工具，但我需要一些 2010 的工具。

【问题讨论】：

您认为“集成”是什么？上下文相关的帮助弹出窗口？

@Macro - 我正在寻找一个允许我使用 Visual Studio 创作和编译帮助文件的工具。

帮助文件中有哪些主题或内容：最终用户/UI 主题？还是软件/API 主题？

@ChrisW - 最终用户主题。这将是 CHM 或其他格式（HTML、PDF 等）文件。

【参考方案1】：

这是您的选择...

如果你想要微软的文档生成器与 VS 集成：

Sandcastle Help File Builder 帮助文件生成 DocProject 将其集成到 VS 中

虽然，DocProject doesn't quite support VS2010 yet.

对于非 MS 解决方案，有 GhostDoc，它确实支持 VS 2010 集成并且似乎是更好的解决方案。

对于未集成到 Visual Studio 中的选项：

DoxyGen Docu NDoc3

【讨论】：

Sandcastle 可能适合记录 API，但不适合记录应用程序 GUI；你不同意吗？

@ChrisW 没有任何应用程序可以从直接从源中提取的 cmets 生成文档，因为 WinForms/WPF 应用程序通常不会在自动生成的 Designer/XAML 文件中包含 cmets。我认为，由于问题是针对自动生成文档的，所以 OP 正在寻求创建“软件用户手册”而不是一般的“用户手册”。

@ChrisW 很好的封闭式暗示性问题。

@EvanPlaice - ghostdoc 实际上会生成 .chm/.html 帮助文件吗？

@Micky Duncan：GhostDoc Pro 可以。

【参考方案2】：

对于工具供应商来说，这是一个尴尬的目标。在大多数商店中，帮助是由在日常活动中对 Visual Studio 没有任何用途的专业作家编写的。 RoboHelp 等第三方创作工具是他们首选的武器。

你可能看到的VS2005 SDK工具是HelpStudio Lite，Innovasys的产品。没有与 VS2010 集成的可用版本，从forum post 来看，他们无意发布一个。他们的文件 X！然而，产品确实如此，听起来像是你应该看看的。 eval 版本可供下载from here。

【讨论】：

Adobe FrameMaker 12 也内置了生成 CHM 的工具，所以一般来说，它可以将 XML 文件（可以在 VS 中制作）转换为 CHM。

【参考方案3】：

我记得大约一年前，Joel 的软件业务论坛上的一些人推荐了 HelpNDoc。

论坛讨论：http://discuss.joelonsoftware.com/default.asp?biz.5.359131.10

【参考方案4】：

正如其他人所说，您可以在所有类级成员和对象上使用 Sandcastle 转换三斜杠 XML MSDN 样式的帮助

/// <summary>
/// I am a method help Header
/// </summary>
/// <param name="parm1">info for param 1</param>
/// <param name="parm2">info for parm2</param>
/// <remarks>Some Extra Info</remarks>
public override void MeMethod(SourceElement rootElm, Subject subject)
...

这是Sandscastle的链接

功能更丰富的帮助生成器与 Visual Studio 2010 集成并生成多种帮助格式是 VSDocMan。它包括一个所见即所得的评论编辑器，并且实际上为您提供了一些代码。非常有用

【参考方案5】：

带有documentx或sandcastle的ghost doc是要走的路...在2010年，Rest仍然非常原始。如果您同时拥有c#和C++项目，那么documentx将是唯一的方式，如果它只是C#那么任何一个很好。

【参考方案6】：

如果您的帮助文件的受众是应用程序的用户 html 帮助 2 不可用，您仍然需要创建一个 chm 文件。可以从您的 winforms 应用程序中为您执行此操作的工具是 Help Generator for Visual Studio，它在准备帮助并将其链接到表单时需要做很多工作。

【参考方案7】：

可能没有与 VS2010 集成，但我记得在 97 年左右使用 RoboHelp 并且没问题：所以如果我现在需要编写帮助文件，我可能会再看一遍，因为它似乎还在 @ 987654321@。虽然看起来相当昂贵，但如果你有一些 Adob​​e 许可证（这对于开发商店来说并不是完全不寻常的），也许你已经有了这个？

【参考方案8】：

Html Help，被 Html Help 2 取代。

http://www.mshelpwiki.com/wiki/tiki-index.php?page=Help2

【讨论】：

链接好像坏了。

【参考方案9】：

刚刚做了很多研究，在测试了各种工具之后，http://www.helpgenerator.com/ 是组建帮助系统的最快方法。