Get-Help

查看 cmdlet 语法、参数和示例，帮助文件可能需先更新。

补充说明

Get-Help 读取本地帮助文件并输出帮助对象，默认显示名称、语法、说明和相关链接；-Examples 只看示例，-Parameter 看单个参数，-Full 看全部内容，-Online 打开浏览器。help 是包装 Get-Help 并分页的函数，man 是它的别名；脚本里直接用 Get-Help 可避免分页阻塞。

管道：以命令名、通配符或 about_ 主题为参数，不消费常规对象管道；要查某个命令的帮助，把名称传给 -Name（位置参数可省略）。权限：阅读帮助不需要管理员；Update-Help 需要联网，更新系统模块的帮助通常需要管理员权限。

边界：Windows 自带帮助可能未安装或未更新，此时 Get-Help 只显示自动生成的语法，没有描述和示例。版本：-ShowWindow 是 5.1 的图形窗口参数，7.x 不支持；7.x 的 -Online 链接指向当前版本的文档，5.1 指向 5.1 文档。

常用示例

# 1. 查看基本帮助，先确认命令用途和语法
PS C:\> Get-Help Get-ChildItem

# 2. 只看示例，快速找可用写法
PS C:\> Get-Help Get-ChildItem -Examples

# 3. 查单个参数的绑定、默认值和是否接受管道
PS C:\> Get-Help Get-ChildItem -Parameter Path

# 4. 阅读概念主题，例如执行策略的正式说明
PS C:\> Get-Help about_Execution_Policies

# 5. 在浏览器打开当前版本的官方文档
PS C:\> Get-Help Get-Process -Online

# 6. 更新系统模块帮助；需要联网，系统目录通常要管理员
PS C:\> Update-Help -Module Microsoft.PowerShell.Management -Force

易错点与排错

• 帮助只有语法、没有说明，通常是帮助文件未安装；先 Update-Help，离线环境用 Save-Help/Update-Help -SourcePath 分发。
• -Examples 可能为空，尤其是自定义函数没有注释帮助；用 Get-Help <函数> -Full 看是否有 comment-based help。
• -Online 只打开浏览器，不把内容打印到控制台，也不能直接管道处理；需要文本时用 -Full。
• help 会分页并等待按键，放进无人值守脚本会阻塞；脚本统一用 Get-Help。
• -Full 输出很长，终端里不便查找；用 -Parameter * 或 -Examples 缩小范围。
• 5.1 的 -ShowWindow 在 7.x 不存在，跨版本脚本不要使用；7.x 用 -Online 或终端分页替代。
• 帮助内容有语言版本差异；英文参数名不变，但描述可能缺失，必要时用 -Online 对照官方英文页。

相关命令

• Get-Command — 先确认命令存在及其来源。
• PowerShell — 理解 5.1/7.x 帮助与文档差异。
• Get-ChildItem — 用帮助核对参数和行为。
• Get-Service — 查服务命令的完整参数说明。

参考链接

• Microsoft Learn: Get-Help
• Microsoft Learn: about_Comment_Based_Help

读完自测

合上页面，先回答，再展开对照。

1. 为什么 Get-Help 有时只显示语法，没有说明和示例？
2. 脚本里为什么应使用 Get-Help 而不是 help？
3. -Online 和 -Full 各适合什么场景？