合并本地 .net 库文档答案

【问题标题】：merge local .net library documentation合并本地 .net 库文档
【发布时间】：2012-05-27 18:32:11
【问题描述】：

当我在某个 .net 关键字上按 F1 时，它会将我带到该关键字的帮助页面。我有一个 .net 库及其文档。我正在使用这个库。当我在这个库中的某些功能上按 F1 时，如何使用 F1 获得库帮助？

一般来说，我们如何将本地文档与 .net 文档合并？

【问题讨论】：

【解决方案1】：

你确定你需要那个吗？通常的方法是使用智能感知为您的库提供上下文帮助，生成 xml 文件。

查看this 和this 相关条目。

还有：

【讨论】：

Visual Studio 中的 IntelliSense 功能仅提供 XML 文件可能包含的文档的一小部分 - 基本上仅限于 <summary> 和 <param> 标记。 F1 集成用于显示 .NET Framework 中任何类型/成员的扩展信息，因此为了保持一致性，最好以相同的方式支持您自己的 SDK 文档。

【解决方案2】：

除非该库提供帮助 2/3 文件，否则您将无法实现，

【讨论】：

【解决方案3】：

查看Sandcastle Help File Builder，它可以生成帮助 1 (.chm) 文件、MS 帮助 2 (.HxS) 文件、MS 帮助查看器 (.mshc) 和/或网站。

HTML Help 2.x 输出包括一组有效的集合文件和 H2Reg.exe 配置文件，以简化帮助文件的部署和集成到现有集合（例如 Visual Studio 使用的集合）中。

【讨论】：