我需要在 Visual Studio 2010 中为 WinForms 应用程序编写帮助文件。理想情况下,我想使用与 Visual Studio 集成的工具,而不是完全独立的工具。
过去我使用过 HTML Help Workshop,但这是很古老的,我记得它使用起来有点时髦。我也知道 Visual Studio 2005 SDK 中内置了一个工具,但我需要一些 2010 的东西。
我需要在 Visual Studio 2010 中为 WinForms 应用程序编写帮助文件。理想情况下,我想使用与 Visual Studio 集成的工具,而不是完全独立的工具。
过去我使用过 HTML Help Workshop,但这是很古老的,我记得它使用起来有点时髦。我也知道 Visual Studio 2005 SDK 中内置了一个工具,但我需要一些 2010 的东西。
这是您的选择...
如果你想要微软的带有 VS 集成的文档生成器:
对于非 MS 解决方案,有GhostDoc,它确实支持 VS 2010 集成,并且似乎是一个更好的解决方案。
对于未集成到 Visual Studio 中的选项:
对于工具供应商来说,这是一个尴尬的目标。在大多数商店中,帮助是由在日常活动中对 Visual Studio 没有任何用途的专业作家编写的。RoboHelp 等第三方创作工具是他们首选的武器。
您可能看到的 VS2005 SDK 工具是Innovasys 的产品HelpStudio Lite。没有可用的版本与 VS2010 集成,从论坛帖子来看,他们无意发布一个。他们的文件 X!然而,产品确实如此,听起来像是你应该看看的。评估版可从此处下载。
我记得大约一年前,Joel 的 The Business of Software 论坛上的一些人推荐了HelpNDoc。
论坛讨论:http ://discuss.joelonsoftware.com/default.asp?biz.5.359131.10
带有 documentx 或 sandcastle 的 ghost doc 是要走的路……在 2010 年,Rest 仍然非常原始。如果你同时拥有 c# 和 C++ 项目,那么 documentx 将是一种方式,如果它只是 C# 那么任何一个都很好。
正如其他人所说,您可以在所有类级成员和对象上使用 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){
...
与 Visual Studio 2010 集成并生成多种帮助格式的功能更丰富的帮助生成器是VSDocMan。它包括一个所见即所得的评论编辑器,并且实际上为您评论了您的一些代码。非常有用
如果您的帮助文件的受众是应用程序的用户 html 帮助 2 不可用,您仍然需要创建一个 chm 文件。可以从您的 winforms 应用程序中为您执行此操作的工具是Help Generator for Visual Studio,它消除了准备帮助并将其链接到表单的大量工作。
Html 帮助,被 Html 帮助 2 取代。
刚刚做了很多研究,在测试了各种工具之后,http://www.helpgenerator.com/是组建帮助系统的最快方法。
可能没有与 VS2010 集成,但我记得在 97 年左右使用 RoboHelp 并且没问题:所以如果我现在需要编写帮助文件,我可能会再看一遍,因为它似乎还在附近。虽然看起来相当昂贵,但如果你有一些 Adobe 许可证(这对于开发商店来说并不是完全不寻常的),也许你已经有了这个?