logo标签列表

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

winformsvisual-studio-2010chmhelpfile
19

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

过去我曾使用过HTML Help Workshop，但这已经过时了，并且我记得使用起来有点奇怪。我也知道Visual Studio 2005 SDK内置了一个工具，但我需要适用于2010的工具。

你认为“集成”是什么？上下文相关的帮助弹出窗口吗？ - Marco van de Voort
@Macro - 我正在寻找一种工具，可以让我使用Visual Studio编写和编译帮助文件。 - Jon B
帮助文件中会包含哪些主题或内容：是面向最终用户/用户界面的主题？还是软件/API主题？ - ChrisW
@ChrisW - 最终用户主题。这将是一个CHM或其他格式（HTML，PDF等）的文件。 - Jon B
9个回答
13
4
沙堡可能适用于记录API文档，但不适用于记录应用程序GUI的文档；你同意吗？ - ChrisW
@ChrisW，没有任何从源代码中直接提取注释生成文档的应用程序可以做到这一点，因为WinForms/WPF应用程序通常不在自动生成的Designer/XAML文件中包含注释。我假设，由于问题是针对自动生成文档的，所以OP正在寻求创建一个“软件用户手册”，而不是一个普通的“用户手册”。 - Evan Plaice
@ChrisW 不错的封闭式建议性问题。 - Evan Plaice
@EvanPlaice - GhostDoc真的能生成.chm/.html帮助文件吗？ - user585968
@Micky Duncan: GhostDoc Pro可以。 - Ross Presser
7

对于工具供应商来说，这是一个棘手的目标。在大多数商店中，帮助文档都是由专业作家撰写的，他们在日常活动中没有任何使用Visual Studio的需要。第三方编写工具，如RoboHelp是他们的首选武器。

你可能看到的VS2005 SDK工具是Innovasys的产品HelpStudio Lite。目前还没有与VS2010集成的版本，根据论坛帖子，他们也没有发布的意向。但他们的Document X!产品有，听起来你应该看一下。评估版本可以从这里下载。

1
Adobe FrameMaker 12具备内置工具，可生成CHM文件，因此它可以将XML文件（可在VS中创建）转换为CHM格式。 - user2868288
5
1

正如其他人所说，您可以使用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的链接

VSDocMan是一个更加丰富功能的帮助文档生成器，它可以与Visual Studio 2010集成，并生成多种帮助格式。它包括一个所见即所得的注释编辑器，并为您的代码添加注释。非常有用。

1

如果您的帮助文件的受众是应用程序的用户，则无法使用HTML Help 2，您仍然需要创建CHM文件。可以从WinForms应用程序为您执行此操作的工具是Visual Studio帮助生成器，它可以减少准备帮助和将其链接到表单所需的大量工作。

1

使用documentx或sandcastle来进行Ghost Doc是最佳选择……在2010年，其他方式仍然非常原始。如果项目同时包括C#和C++，则documentx是最好的选择；如果只有C＃，则任何一种方式都可以。

0

可能不支持VS2010，但我记得在'97年左右使用RoboHelp还可以：如果现在需要编写帮助文件，我可能会再次考虑它，因为似乎它仍然存在这里。看起来相当昂贵，但如果您已经拥有一些Adobe许可证（对于开发商来说并不完全不寻常）出于其他原因，也许您已经拥有了这个？

0
链接似乎已经损坏。 - EJoshuaS - Stand with Ukraine
0
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接