为带ArgumentCompletions属性的参数设置默认值遇异常求助

问题重现 #

函数代码 #

function Get-CommandBar{
    [CmdletBinding()]
    [Alias("GCom")]
    Param(
        [Parameter()]
        [string]$Path = $pwd,
        [Parameter()]
        [ArgumentCompletions('Path', 'Copy')]
        $ActiveTab = 'Path',
        [Switch]$ActiveVideo,
        [Switch]$AllTabs
        )
    
        begin{
            
                
        }
        process {
            Switch ($PSBoundParameters.Keys){
                'ActiveTab'{ 
                    If ($ActiveTab -eq "Path"){
                        "Path"
                    }elseif($ActiveTab -eq "Copy"){
                        "Copy"
                    }
                }
                'AllTabs'{
                    "All Tabs"
                }
                'ActiveVideo'{
                    "Active Video"
    
                }
         }
        }
}

执行结果 #

• 执行 Get-CommandBar -ActiveTab Path，输出：

Path

• 执行 Get-CommandBar -ActiveTab Copy，输出：

Copy

• 执行 Get-CommandBar -ActiveTab，报错：

Get-CommandBar: Missing an argument for parameter 'ActiveTab'. Specify a parameter of type 'System.Object' and try again.

原因分析 #

1. 默认值生效逻辑限制：PowerShell参数默认值仅在未显式指定该参数时触发。当你输入-ActiveTab时，已经明确声明要使用这个参数，PowerShell会要求传入对应值，不会再调用默认值。
2. 未指定参数类型的影响：$ActiveTab未声明类型，默认是[object]类型，这种情况下PowerShell对参数值的校验更严格，缺少值时直接抛出错误。
3. ArgumentCompletions的作用范围：[ArgumentCompletions()]仅提供命令行补全候选值，不会改变参数的类型、默认值逻辑，也无法让参数变成无需传值的开关型参数。

解决方法 #

方案1：规范参数定义，遵循默认值逻辑 #

给$ActiveTab显式声明[string]类型，保留默认值。此时默认值会在不指定-ActiveTab参数时生效，执行Get-CommandBar不带参数即可输出默认的Path；若指定-ActiveTab则必须传入补全候选值中的一个。

修改后的参数部分：

[Parameter()]
[string]
[ArgumentCompletions('Path', 'Copy')]
$ActiveTab = 'Path'

同时调整process块，确保无参数时输出默认值：

process {
    # 无参数时默认输出ActiveTab的默认值
    if (-not $PSBoundParameters.Keys) {
        "Path"
        return
    }

    Switch ($PSBoundParameters.Keys){
        'ActiveTab'{ 
            If ($ActiveTab -eq "Path"){
                "Path"
            }elseif($ActiveTab -eq "Copy"){
                "Copy"
            }
        }
        'AllTabs'{
            "All Tabs"
        }
        'ActiveVideo'{
            "Active Video"
        }
    }
}

方案2：支持显式指定-ActiveTab不带值时用默认值（可选） #

如果需要用户输入-ActiveTab不带值也能触发默认值，需添加参数空值允许配置，并手动在代码中补全默认值：

修改后的函数：

function Get-CommandBar{
    [CmdletBinding()]
    [Alias("GCom")]
    Param(
        [Parameter()]
        [string]$Path = $pwd,
        [Parameter()]
        [AllowNull()]
        [string]
        [ArgumentCompletions('Path', 'Copy')]
        $ActiveTab = 'Path',
        [Switch]$ActiveVideo,
        [Switch]$AllTabs
        )
    
    begin{}
    process {
        # 处理显式指定-ActiveTab但未传值的情况
        if ($PSBoundParameters.ContainsKey('ActiveTab') -and [string]::IsNullOrEmpty($ActiveTab)) {
            $ActiveTab = 'Path'
        }

        # 无参数时默认输出ActiveTab值
        if (-not $PSBoundParameters.Keys) {
            "Path"
            return
        }

        Switch ($PSBoundParameters.Keys){
            'ActiveTab'{ 
                If ($ActiveTab -eq "Path"){
                    "Path"
                }elseif($ActiveTab -eq "Copy"){
                    "Copy"
                }
            }
            'AllTabs'{
                "All Tabs"
            }
            'ActiveVideo'{
                "Active Video"
            }
        }
    }
}

补充说明 #

如果需要同时限制参数值只能是指定候选值，推荐使用[ValidateSet('Path', 'Copy')]代替[ArgumentCompletions()]，它既提供补全功能，又会校验输入值的合法性，避免无效输入。

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