可更新的帮助概述

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

介绍

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

Windows PowerShell 3.0 中引入的可更新帮助功能可确保用户在命令提示符处获得最新版本的帮助主题，即使对于内置 PowerShell 命令也是如此，而无需下载新模块或运行 Windows Update。可更新帮助通过提供从 Internet 下载最新版本的帮助主题并将其安装在用户本地计算机上正确的子目录中的 cmdlet，使更新变得简单。即使位于防火墙后面的用户也可以使用新的 cmdlet 从内部文件共享获取更新的帮助。

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

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

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

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

• 模块帮助。模块的帮助文件作为一个单元进行管理和交付，因此用户可以获得他们使用的模块的所有帮助文件。仅模块支持可更新帮助，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。您可以通过向 cmdlet、函数和 CIM 命令的代码添加 HelpUri 属性，或使用 .Link 注释来填充 HelpUri 属性工作流程和脚本中基于 - 的帮助指令。

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