如何向 Windows 窗体添加帮助答案

【问题标题】：How to add help to windows forms如何向 Windows 窗体添加帮助
【发布时间】：2009-07-25 01:55:17
【问题描述】：

我有一个相当简单的 Windows 窗体应用程序，我想在其中添加“帮助”。

我想到的是一个简单的单页 html 页面，它描述了有关应用程序的一些详细信息。我想我必须在应用程序中添加某种浏览器才能显示 html 页面。

我是否缺少其他选项？寻找建议。

【问题讨论】：

【解决方案1】：

您可以将 HTML 帮助页面放在应用程序旁边的磁盘上。要显示帮助页面，只需启动它并让默认浏览器处理它：

string appPath = Assembly.GetEntryAssembly().Location;
string filename = Path.Combine(Path.GetDirectoryName(appPath), "help.htm");
Process.Start(filename);

【讨论】：

【解决方案2】：

您的解决方案假定应用程序的用户可以访问互联网。这可以接受吗？

有一个browser control 用于允许浏览网页的表单。

如果没有，请考虑将简单的帮助页面作为表单放入应用程序本身，就像 Microsoft Office 产品中的帮助菜单一样。

【讨论】：

如果您的意思是 adrianbanks 解决方案，它不需要互联网访问。它从本地 html 文件加载帮助。浏览器控件也是一个不错的选择。

【解决方案3】：

作为 System.Windows.Forms 一部分的 Help 类可能会为您提供一些选择：

http://msdn.microsoft.com/en-us/library/system.windows.forms.help.aspx

【讨论】：

【解决方案4】：

您也可以使用 chm 文件来获得帮助，这些类型的文件（以及 html 文件）可以从代码中的 XML cmets 生成。然后，您可以使用像 sandcastle 这样的帮助文件构建器来帮助从代码中的 XML cmets 生成 chm 和/或 html 帮助文件。如果您为项目启用了 XML cmets，您将获得一个额外的 .xml 文件，该文件在您构建解决方案时生成，用于生成帮助文件。然后您可以从您的 Windows 应用程序中引用该帮助文件。这对我们有用！

【讨论】：

Windows 应用程序的帮助文件肯定不是代码的 XMLDocs 吗？不过，您对制作 HTML 帮助页面的 chm 文件是正确的。
:) 是的，如果代码特定于您的代码（开发人员说明），请不要使用代码中的 XML，但如果您出于帮助目的编写 XML cmets，则可以使用 sandcastle 和 XMLDocs。跨度>