替代 Help Viewer 默认值

  • 项目

可以更改 Visual Studio IDE 中的 Microsoft Help Viewer 和帮助相关功能的默认行为。

帮助内容管理器是一种可用于部署和管理本地 Help Viewer 内容的工具。 若要更改 Help Viewer 行为，可以替代帮助内容管理器可执行程序 (HlpCtntMgr.exe) 的默认设置。

可通过不同方法设置帮助内容管理器选项：

  • 创建 .pkgdef 文件以设置注册表项值。
  • 直接在注册表中设置选项。

使用 .pkgdef 文件更改 Help Viewer 行为

.pkgdef 文件可存储 Help Viewer 使用的配置信息。 可以使用 .pkgdef 文件调整下表所列的注册表项值：

注册表项值 类型 数据 说明
NewContentAndUpdateService 字符串 <service endpoint URL> 定义唯一的服务终结点
UseOnlineHelp dword 0 指定本地帮助，1 指定联机帮助 定义联机或脱机帮助（默认）
OnlineBaseUrl 字符串 <service endpoint URL> 定义唯一的 F1 终结点
OnlineHelpPreferenceDisabled dword 0 启用或 1 禁用联机帮助首选项 禁用联机帮助首选项
DisableManageContent dword 0 启用或 1 禁用 Help Viewer 中的“管理内容”选项卡 禁用“管理内容”选项卡
DisableFirstRunHelpSelection dword 0 启用或 1 禁用在 Visual Studio 首次启动时配置的帮助功能 禁用首次启动 Visual Studio 时的内容安装

若要在 .pkgdef 文件中设置注册表项值，请执行以下步骤：

  1. 创建一个新文件，并为其指定扩展 .pkgdef。

  2. 将以下文本添加到文件第一行：

    [$RootKey$\Help]

  3. 在单独的行中，添加上表描述的任何注册表项值。 例如，可以添加以下行来配置 UseOnlineHelp 值：

    "UseOnlineHelp"=dword:00000001

  4. 将文件复制到 Visual Studio 安装的“CommonExtensions”文件夹。 例如：

    • 如果使用 Visual Studio 2017 社区版，请将 .pkgdef 文件添加到此文件夹：

      C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions

    • 如果使用 Visual Studio 2022 社区版，请将 .pkgdef 文件添加到此文件夹：

      C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\CommonExtensions

  5. 在开发者命令提示符处运行此命令：

    devenv /updateconfiguration

示例 .pkgdef 文件内容

[$RootKey$\Help]
"NewContentAndUpdateService"="https://some.service.endpoint"
"UseOnlineHelp"=dword:00000001
"OnlineBaseUrl"="https://some.service.endpoint"
"OnlineHelpPreferenceDisabled"=dword:00000000
"DisableManageContent"=dword:00000000
"DisableFirstRunHelpSelection"=dword:00000001

使用注册表编辑器更改帮助查看器的行为

可以通过在注册表编辑器中设置注册表项值来控制以下类型的行为。

任务 注册表项 Value 数据
替代 BITS 作业优先级 HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node（64 位计算机上）\Microsoft\Help\v2.3 BITSPriority foreground、high、normal 或 low
指向网络共享上的本地内容存储区 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\ v2.3\Catalogs\VisualStudio15 LocationPath ContentStoreNetworkShare

相关内容