Синтаксическая секция 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>]

Вы также можете проверить это онлайн .