CBH的语法部分

Question

我的脚本的基于注释的帮助文档的语法部分如下所示

SYNTAX
C:\scripts\forms_invoke.ps1 [[-proc_type] <String>] [<CommonParameters>]

但是-proc_type参数只能是三个不同值之一。参数和描述部分对此进行了说明。如何更改CBH以在SYNTAX部分显示此信息？

Answer 1

您可以在特定参数处添加ValidateSet属性。 Powershell选项卡补全将仅建议集合中受支持的值。

Function test-docu{
[cmdletbinding()] 
Param(
   [ValidateSet ("a", "b")] 
    $p1
 ) 
}

Get-Help Test-docu

输出：

NAME
test-docu

 SYNTAX
     test-docu [[-p1] {a | b}]      
 [<CommonParameters>]

您也可以online对其进行测试。