首页/系统/Windows 运维速查/Get-Help 查看帮助与示例
PowerShell 基础66 条

Get-Help 查看帮助与示例

PowerShell 内置帮助系统:查看语法、参数、示例与概念说明,比背命令更可靠;-Online 可打开官方文档。

Windows 运维速查系统更新于 2026-10-13

Get-Help 是什么

Get-Help 是 PowerShell 内置的帮助系统,用来查看命令的语法、参数、示例与相关概念。它比背命令可靠得多:不确定参数名就用 -Parameter 精确查,不知道怎么用就看 -Examples 里的例子,需要深入理解就上 -Full 看完整说明。

基本信息

适用平台Windows PowerShell 5.1 与 PowerShell 7
语法Get-Help 命令名 [-Full|-Detailed|-Examples|-Parameter 名称] [-Online]
等价写法help 命令名(分页显示)、命令名 -?
概念帮助about_ 前缀主题,例如 about_Execution_Policies
更新帮助Update-Help 需要联网与权限,-Online 只需能访问文档站点
首次使用未更新帮助时内容可能不完整

典型使用场景

  • 记不清参数名时用 -Parameter 精确定位,而不是靠猜
  • 学习新命令先看示例,照着例子改比读语法快得多
  • 排障时看 -Full 里的详细说明与适用版本要求
  • 查概念主题理解语言机制,例如管道链、运算符优先级
  • 需要最新文档时用 -Online 打开官方页面

常用示例

常用示例
# 看示例,最快上手
Get-Help Get-ChildItem -Examples
# 查某个参数的具体说明
Get-Help Test-NetConnection -Parameter Port
# 完整帮助,含参数细节与备注
Get-Help Get-WinEvent -Full
# 概念主题:管道链
help about_Pipeline_Chain
# 打开在线文档,需要能联网
Get-Help Get-Process -Online
# 更新本地帮助内容
Update-Help -ErrorAction SilentlyContinue

帮助内容分层

写法内容范围适用场景
默认语法、简要说明与参数列表快速回忆用法
-Examples只显示示例照着写命令
-Detailed增加参数详细说明深入理解某个参数
-Full完整内容含备注与相关主题排障与深入研究
about_ 主题概念与机制说明理解语言特性
没有执行过更新帮助时,-Full 与 -Detailed 的内容可能不完整,这属于正常现象;-Online 需要能访问官方文档站点,内网环境可能不可用。
参数名支持前缀匹配,写缩写通常也能识别,但存在多个候选时会报错。正式脚本与文档里建议写全名,避免版本差异带来的歧义。

易错点

  • 未更新帮助就以为说明缺失,其实先执行一次更新即可获得完整内容
  • 内网环境依赖 -Online 会失败,应确认能否访问外部文档站点
  • 参数名缩写存在多个候选时会直接报错,脚本与文档应写全名
  • 把 help 与 Get-Help 的输出差异误当成不同命令,前者默认分页更易读
  • -Full 输出量很大,直接刷屏会错过关键段落,建议重定向到文件再阅读

数据来源与参考

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

相关工具

​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌