Powershell komut dosyası parametrelerim için yardım iletilerinin görünmesini nasıl sağlayabilirim?

Question

Geliştirme ortamı kurulum komut dosyalarımız için giriş noktası olarak kullandığımız bir powershell komut dosyasına (setup.ps1) sahibim. Bu bir parametre alır: Ben parametreler bölümünde

PS > get-help .\setup.ps1 -detailed 

çalıştırdığınızda

param(
    [Parameter(Position=0,HelpMessage="The targets to run.")] 
    [Alias("t")] 
    [string[]] 
    $Targets = "Help" 
) 

, benim yardım mesajı görünmüyor: Ne almak için yapmanız gereken ne yapıyoruz

PARAMETERS 
    -Targets <String[]> 

parametre yardım iletilerim görüntülenecek?

Answer 1

Dosyanın en üstünde, PowerShell yardım sistemi tarafından kodu çözülebilecek belirli bir yorum stili belirlediniz. İşte bir örnek:

<# 
.SYNOPSIS 
    . 
.DESCRIPTION 
    . 
.PARAMETER Path 
    The path to the . 
.PARAMETER LiteralPath 
    Specifies a path to one or more locations. Unlike Path, the value of 
    LiteralPath is used exactly as it is typed. No characters are interpreted 
    as wildcards. If the path includes escape characters, enclose it in single 
    quotation marks. Single quotation marks tell Windows PowerShell not to 
    interpret any characters as escape sequences. 
.EXAMPLE 
    C:\PS> 
    <Description of example> 
.NOTES 
    Author: Keith Hill 
    Date: June 28, 2010  
#> 
function AdvFuncToProcessPaths 
{ 
    [CmdletBinding(DefaultParameterSetName="Path")] 
    param(
     [Parameter(Mandatory=$true, Position=0, ParameterSetName="Path", 
        ValueFromPipeline=$true, 
        ValueFromPipelineByPropertyName=$true, 
        HelpMessage="Path to ...")] 
     [ValidateNotNullOrEmpty()] 
     [string[]] 
     $Path, 

     [Alias("PSPath")] 
     [Parameter(Mandatory=$true, Position=0, ParameterSetName="LiteralPath", 
        ValueFromPipelineByPropertyName=$true, 
        HelpMessage="Path to ...")] 
     [ValidateNotNullOrEmpty()] 
     [string[]] 
     $LiteralPath 
    ) 
    ... 

fazla bilgi için yardım konusuna bakın - man about_comment_based_help.

Answer 2

bir yardım başlığı tanımladıktan Anlaşılan eğer, sadece parametre arkasında bir açıklama (#) kullanabilir (bu örnekte:. #The hedefleri çalıştırmak için):

<# 
.SYNOPSIS 
    . 
.DESCRIPTION 
    . 
.PARAMETER Path 
    The path to the . 
.PARAMETER LiteralPath 
    Specifies a path to one or more locations. Unlike Path, the value of 
    LiteralPath is used exactly as it is typed. No characters are interpreted 
    as wildcards. If the path includes escape characters, enclose it in single 
    quotation marks. Single quotation marks tell Windows PowerShell not to 
    interpret any characters as escape sequences. 
#> 

Param(
    [String]$Targets = "Help" #The targets to run. 
) 

Sonuçları

PS C:\> Get-help .\Setup.ps1 -Detailed 

NAME 
    C:\Setup.ps1 

SYNOPSIS 
    . 


SYNTAX 
    C:\Setup.ps1 [[-Targets] <String>] [<CommonParameters>] 


DESCRIPTION 
    . 


PARAMETERS 
    -Targets <String> 
     The targets to run.