如何可靠提取Get-Help输出的语法段为字符串？

要同时兼容内置Cmdlet和自定义函数的语法提取，核心是利用PowerShell的内置格式化系统统一处理两种不同类型的Syntax属性（字符串 vs CommandSyntax对象数组）。以下是可靠的实现方法：

编写syntax函数 #

直接使用Format-List结合Out-String渲染语法内容，确保输出和Get-Help原生显示格式一致：

function syntax {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory, Position=0)]
        [string]$CommandName
    )

    try {
        # 获取目标命令的帮助对象
        $helpObj = Get-Help -Name $CommandName -ErrorAction Stop
        
        # 通过Format-List触发内置格式化逻辑，将Syntax转为标准文本
        $syntaxLines = $helpObj | Format-List -Property Syntax | Out-String -Stream
        
        # 跳过格式头部的"Syntax :"行，过滤空行后输出
        $syntaxLines | Select-Object -Skip 1 | Where-Object { $_ -match '\S' }
    }
    catch {
        Write-Error "无法获取命令 '$CommandName' 的帮助信息: $_"
    }
}

原理说明 #

• 内置Cmdlet的Syntax属性本身是字符串，Format-List会直接输出其内容
• 自定义高级函数的Syntax是System.Management.Automation.CommandSyntax对象数组，Format-List会调用PowerShell内置格式化器，将这些对象渲染为和Get-Help一致的语法文本
• Out-String -Stream将格式化内容转为字符串数组，方便后续过滤处理
• 最后跳过格式标签行、过滤空行，得到干净的语法文本

使用示例 #

# 查看内置Cmdlet语法
syntax Get-ChildItem

# 查看自定义函数语法
syntax Compile-AutoHotkey

内容的提问来源于stack exchange，提问作者Ralf_Reddings