可更新帮助概述

本文档简要介绍了 PowerShell 可更新帮助功能的设计和作。 它专为向用户提供 Windows PowerShell 帮助主题的模块作者和其他人员设计。

介绍

PowerShell 帮助主题是 PowerShell 体验不可或缺的一部分。 与 PowerShell 模块一样，作者和 PowerShell 用户社区的贡献不断更新和改进帮助主题。

Windows PowerShell 3.0 中引入的 可更新帮助 功能可确保用户在命令提示符下拥有最新版本的帮助主题，即使是内置 PowerShell 命令，也不下载新模块或运行 Windows 更新。 可更新帮助通过提供从 Internet 下载最新版本的帮助主题的 cmdlet，并在用户本地计算机上的正确子目录中安装它们，从而简化更新。 即使是防火墙后面的用户也可以使用新的 cmdlet 从内部文件共享获取更新的帮助。

Windows 8 和 Windows Server 2012 中的所有 Windows PowerShell 模块完全支持可更新帮助，其功能可供所有 Windows PowerShell 模块作者使用。 可更新帮助仅支持基于 XML 的帮助文件。 它不支持基于注释的帮助。

可更新的帮助包括以下功能。

• Update-Help cmdlet，该 cmdlet 确定用户是否具有模块的最新帮助文件，如果不是，则从 Internet 下载最新的帮助文件，将其解压缩，并将其安装在用户计算机上的正确模块子目录中。 用户可以使用 Get-Help cmdlet 立即查看新安装的帮助主题。 无需重启 PowerShell。

• Save-Help cmdlet，该 cmdlet 从 Internet 下载最新的帮助文件，并将其保存在文件系统目录中。 用户可以使用 Update-Help cmdlet 从文件系统目录中获取帮助文件，并将其解压缩并安装到用户的计算机上的模块子目录中。 Save-Help cmdlet 专为具有有限或无 Internet 访问的用户和希望限制 Internet 访问的企业而设计。

• 模块 的帮助。 模块的帮助文件作为一个单元进行管理和交付，以便用户可以获取他们使用的模块的所有帮助文件。 仅支持模块的可更新帮助，而不支持 Windows PowerShell 管理单元。

• 版本支持。 可更新帮助使用标准四位（N1）。N2.N3.N4） 版本号。 当用户的计算机（或 Save-Help 目录中的帮助文件）的版本号低于 Internet 位置的帮助文件的版本号时，可更新帮助下载帮助文件。

• 多语言支持。 可更新帮助支持多个 UI 区域性中的模块帮助文件。 可更新的帮助文件名包括标准语言代码，例如“en-US”和“ja-JP”，Update-Help 和 Save-Help cmdlet 会将帮助文件放入模块目录的语言特定子目录中。

• 自动生成的帮助。 Get-Help cmdlet 显示没有帮助文件的命令的基本帮助。 自动生成的帮助包括命令语法和别名，以及有关使用联机帮助和可更新帮助的说明。

• 增强联机帮助。 轻松访问联机帮助不再需要帮助文件。 Get-Help cmdlet 的 Online 参数现在从任何命令的 HelpUri 属性的值获取联机帮助主题的 URL（如果它找不到帮助文件中的联机帮助 URL）。 通过将 HelpUri 属性添加到 cmdlet、函数和 CIM 命令的代码或使用工作流和脚本中基于注释的帮助关键字 .LINK，可以填充 HelpUri 属性。

  为了使帮助文件可更新，Windows 中的 Windows PowerShell 模块不会附带帮助文件。 用户可以使用可更新帮助安装帮助文件并更新它们。 其他模块的作者可以包括模块中的帮助文件或省略它们。 支持可更新帮助是可选的，但建议使用。