Compartilhar via


about_Comment_Based_Help

Aplica-se a: Windows PowerShell 2.0, Windows PowerShell 3.0

Insira a introdução aqui.

TÓPICO

about_Comment_Based_Help

DESCRIÇÃO BREVE

Descreve como escrever tópicos de ajuda baseada em comentários para funções e scripts.

DESCRIÇÃO LONGA

Você pode escrever tópicos de ajuda baseada em comentários para funções e scripts usando palavras-chave especiais de comentários de ajuda.

O cmdlet Get-Help exibe a ajuda baseada em comentários no mesmo formato em que exibe os tópicos de ajuda para cmdlets que serão gerados por meio de arquivos XML. Os usuários podem usar todos os parâmetros do Get-Help, como Detailed, Full, Example e Online, para exibir o conteúdo da ajuda baseada em comentário.

Você também pode escrever arquivos de ajuda baseada em XML para funções e scripts. Para habilitar o cmdlet Get-Help localizar o arquivo de ajuda baseada em XML para uma função ou um script, use a palavra-chave ExternalHelp. Sem essa palavra-chave, o Get-Help não consegue localizar tópicos de ajuda baseada em XML para funções ou scripts.

Este tópico explica como escrever tópicos de ajuda para funções e scripts. Para obter informações sobre como exibir tópicos de ajuda para funções e scripts, consulte Get-Help.

OBSERVAÇÃO:

Os cmdlets Update-Help e Save-Help funcionam somente em arquivos XML. A ajuda atualizável não dá suporte a tópicos de ajuda baseada em comentários.

OBSERVAÇÃO DE SOLUÇÃO DE PROBLEMAS:

Os valores padrão e um valor para "Accept Wildcard characters" não aparecem na tabela de atributos do parâmetro, mesmo quando eles forem definidos na função ou no script. Para ajudar os usuários, forneça essas informações na descrição do parâmetro.

SINTAXE DA AJUDA BASEADA EM COMENTÁRIOS

A sintaxe da ajuda baseada em comentários é a seguinte:

        # .< help keyword>
        # <help content>
 
    -or -

        <#
            .< help keyword>
            < help content>
        #>

A ajuda baseada em comentários é escrita como uma série de comentários. Você pode digitar um símbolo de comentário (#) antes de cada linha ou usar os símbolos "<#" e "#>" para criar um bloco de comentário. Todas as linhas dentro do bloco de comentário são interpretadas como comentários.

Todas as linhas em um tópico de ajuda baseada em comentários devem ser contíguas. Se um tópico de ajuda baseada em comentário seguir um comentário que não faz parte do tópico de ajuda, deve haver pelo menos uma linha em branco entre a última linha de comentário não relacionada à ajuda e o início da ajuda baseada em comentários.

As palavras-chave definem cada seção da ajuda baseada em comentários. Cada palavra-chave de ajuda baseada em comentários é precedida por um ponto (.). As palavras-chave podem aparecer em qualquer ordem. Os nomes das palavra-chave não diferenciam maiúsculas de minúsculas.

Por exemplo, a palavra-chave Description precede uma descrição de uma função ou script.

        <#
    .Description
            Get-Function displays the name and syntax of all functions in the session.
        #>

O bloco de comentário deve conter pelo menos uma palavra-chave. Algumas palavras-chave, como EXAMPLE, podem aparecer várias vezes no mesmo bloco de comentário. O conteúdo de ajuda para cada palavra-chave começa na linha após a palavra-chave e pode abranger várias linhas.

SINTAXE DA AJUDA BASEADA EM COMENTÁRIOS DAS FUNÇÕES

A ajuda baseada em comentários para uma função pode aparecer em um de três locais:

        -- At the beginning of the function body.

        -- At the end of the function body.

        -- Before the Function keyword. There cannot be more than one blank
           line between the last line of the function help and the Function
           keyword.

Por exemplo:

        function Get-Function 
        {
            <#
            .< help keyword>
            < help content>
            #>

            <function commands>
        }


    -or -

        function Get-Function 
        {
            <function commands>

            <#
            .< help keyword>
            < help content>
            #>
        }

    -or -

        <#
        .< help keyword>
        < help content>
        #>
        function Get-Function { }

SINTAXE DA AJUDA BASEADA EM COMENTÁRIOS DOS SCRIPTS

A ajuda baseada em comentários para um script pode aparecer em um dos dois locais a seguir no script.

     -- At the beginning of the script file. Script help can be preceded in the
       script only by comments and blank lines.


     -- If the first item in the script body (after the help) is a function
       declaration, there must be at least two blank lines between the end of the
       script help and the function declaration. Otherwise, the help is
       interpreted as being help for the function, not help for the script.


    -- At the end of the script file. However, if the script is signed, place
       Comment-based help at the beginning of the script file. The end of the 
       script is occupied by the signature block.

Por exemplo:

        <#
        .< help keyword>
        < help content>
        #>


        function Get-Function { }

    -or-


        function Get-Function { }

        <#
        .< help keyword>
        < help content>
        #>

SINTAXE DA AJUDA BASEADA EM COMENTÁRIOS DOS MÓDULOS DE SCRIPT

Em um módulo de script (.psm1), a ajuda baseada em comentários usa a sintaxe para funções, e não para scripts. Você não pode usar a sintaxe de scripts para fornecer ajuda para todas as funções definidas em um módulo de script.

Por exemplo, se você estiver usando a palavra-chave ExternalHelp para identificar os arquivos de ajuda baseada em XML para as funções de um módulo de script, é necessário adicionar um comentário de ExternalHelp para cada função.

    # .ExternalHelp <XML-file-name>
    function <function-name>
    {
        ...
    }

PALAVRAS-CHAVE DA AJUDA BASEADA EM COMENTÁRIOS

A seguir, há as palavras-chave válidas para a ajuda baseada em comentários. Elas são listadas na ordem em que geralmente aparecem em um tópico de ajuda com seu uso pretendido. Essas palavras-chave podem aparecer em qualquer ordem na ajuda baseada em comentários, e não diferenciam maiúsculas de minúsculas.

.SYNOPSIS

Uma breve descrição da função ou do script. Essa palavra-chave só pode ser usada uma vez em cada tópico.

.DESCRIPTION

Uma descrição detalhada da função ou do script. Essa palavra-chave só pode ser usada uma vez em cada tópico.

.PARAMETER <Nome-Parâmetro>

A descrição de um parâmetro. Adicione uma palavra-chave .PARAMETER para cada parâmetro da sintaxe da função ou do script.

Digite o nome do parâmetro na mesma linha da palavra-chave .PARAMETER. Digite a descrição do parâmetro nas linhas após a palavra-chave .PARAMETER. O Windows PowerShell interpreta todo o texto entre a linha .PARAMETER e a próxima palavra-chave ou o final do bloco de comentário como parte da descrição do parâmetro. A descrição pode incluir quebras de parágrafo.

As palavras-chave Parameter podem aparecer em qualquer ordem no bloco de comentário, mas a sintaxe da função ou do script determina a ordem na qual os parâmetros (e suas descrições) aparecem no tópico de ajuda. Para alterar a ordem, altere a sintaxe.

Você também pode especificar uma descrição do parâmetro colocando um comentário na sintaxe da função ou do script imediatamente antes do nome da variável do parâmetro. Se você usar um comentário de sintaxe e uma palavra-chave Parameter, a descrição associada à palavra-chave Parameter será usada, e o comentário de sintaxe será ignorado.

.EXAMPLE

Um comando de exemplo que usa a função ou script, opcionalmente seguido por um exemplo de saída e uma descrição. Repita essa palavra-chave para cada exemplo.

.INPUTS

Os tipos de objetos Microsoft .NET Framework que podem ser redirecionados à função ou ao script. Você também pode incluir uma descrição dos objetos de entrada.

.OUTPUTS

O tipo de objetos .NET Framework que o cmdlet retorna. Você também pode incluir uma descrição dos objetos retornados.

.NOTES

Informações adicionais sobre a função ou o script.

O nome de um tópico relacionado. O valor é exibido na linha abaixo da palavra-chave .LINE e deve ser precedido por um símbolo de comentário (#) ou incluído no bloco de comentário.

Repita a palavra-chave .LINK para cada tópico relacionado.

Esse conteúdo é exibido na seção Links Relacionados do tópico de ajuda.

O conteúdo da palavra-chave Link também pode incluir um URI (Uniform Resource Identifier) para uma versão online do mesmo tópico de ajuda. A versão online é aberta quando você usa o parâmetro Online do Get-Help. O URI deve começar com "http" ou "https".

.COMPONENT

A tecnologia ou recurso que a função ou o script usa, ou ao qual está relacionado. Esse conteúdo é exibido quando o comando Get-Help inclui o parâmetro Component do Get-Help.

.ROLE

A função de usuário do tópico de ajuda. Esse conteúdo é exibido quando o comando Get-Help inclui o parâmetro Role do Get-Help.

.FUNCTIONALITY

O uso pretendido da função. Esse conteúdo é exibido quando o comando Get-Help inclui o parâmetro Functionality do Get-Help.

.FORWARDHELPTARGETNAME <Nome-Comando>

Redireciona ao tópico de ajuda do comando especificado. Você pode redirecionar usuários a qualquer tópico de ajuda, incluindo tópicos de ajuda para uma função, script, cmdlet ou provedor.

.FORWARDHELPCATEGORY <Categoria>

Especifica a categoria de ajuda do item da ForwardHelpTargetName. Os valores válidos são Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filter ou All. Use essa palavra-chave para evitar conflitos quando houver comandos com o mesmo nome.

.REMOTEHELPRUNSPACE <variável-PSSession>

Especifica uma sessão que contém o tópico de ajuda. Insira uma variável que contém uma PSSession. Essa palavra-chave é usada pelo cmdlet Export-PSSession para localizar tópicos de ajuda para os comandos exportados.

.EXTERNALHELP <Arquivo de Ajuda XML>

Especifica um arquivo de ajuda baseada em XML para o script ou função.

A palavra-chave ExternalHelp é necessária quando uma função ou script está documentado em arquivos XML. Sem essa palavra-chave, o Get-Help não pode localizar o arquivo de ajuda baseada em XML para a função ou script.

A palavra-chave ExternalHelp tem precedência sobre outras palavras-chave de ajuda baseada em comentários. Se ExternalHelp estiver presente, o Get-Help não exibe a ajuda baseada em comentários, mesmo se não puder localizar um tópico de ajuda que corresponda ao valor da palavra-chave ExternalHelp.

Se a função for exportada por um módulo, configure o valor da palavra-chave ExternalHelp para um nome de arquivo sem um caminho. O Get-Help procura o nome de arquivo especificado em um subdiretório específico a um idioma do diretório de módulos. Não existem requisitos para o nome do arquivo de ajuda baseada em XML para uma função, mas a prática recomendada é usar o seguinte formato:

        <ScriptModule.psm1>-help.xml

Se a função não estiver incluída em um módulo, inclua um caminho para o arquivo de ajuda baseada em XML. Se o valor incluir um caminho e o caminho contiver subdiretórios específicos da cultura de UI, o Get-Help pesquisa recursivamente os subdiretórios em busca de um arquivo XML com o nome do script ou da função, de acordo com os padrões de fallback de idioma estabelecidos para Windows, assim como faz em um diretório de módulo.

Para obter mais informações sobre o formato do arquivo de ajuda baseada em XML para cmdlet, consulte "Como criar ajuda para cmdlets" na biblioteca MSDN (Microsoft Developer Network) em https://go.microsoft.com/fwlink/?LinkID=123415.

CONTEÚDO GERADO AUTOMATICAMENTE

O nome, a sintaxe, a lista de parâmetros, a tabela de atributos de parâmetros, os parâmetros comuns e os comentários são gerados automaticamente pelo cmdlet Get-Help.

Nome:

A seção Name do tópico de ajuda para uma função é obtida do nome da função incluso na sintaxe da função. O nome do tópico de ajuda para um script é obtido do nome do arquivo de script. Para alterar o nome ou sua capitalização, altere a sintaxe da função ou o nome do arquivo de script.

Sintaxe:

A seção Syntax do tópico de ajuda é gerada da sintaxe da função ou do script. Para adicionar detalhes à sintaxe do tópico de ajuda, como o tipo .NET Framework de um parâmetro, adicione os detalhes à sintaxe. Se você não especificar um tipo de parâmetro, o tipo "Object" será inserido como o valor padrão.

Lista de parâmetros:

A lista de parâmetros do tópico de ajuda é gerada da sintaxe da função ou do script e das descrições que você adicionar usando a palavra-chave Parameters. Os parâmetros da função aparecem na seção "Parameters" do tópico de ajuda, na mesma ordem em que aparecem na sintaxe da função ou do script. A ortografia e a capitalização dos nomes de parâmetros também são obtidos da sintaxe; elas não são afetadas pelo nome do parâmetro especificado pela palavra-chave Parameter.

Parâmetros comuns:

Os parâmetros comuns são adicionados à sintaxe e à lista de parâmetros do tópico de ajuda, mesmo se eles não tiverem nenhum efeito. Para obter mais informações sobre os parâmetros comuns, consulte about_CommonParameters.

Tabela de atributos dos parâmetros:

O Get-Help gera a tabela de atributos dos parâmetros que é exibida quando você usa o parâmetro Full ou Parameter do Get-help. Os atributos de valor Required, Position e Default são obtidos da sintaxe da função ou do script.

OBSERVAÇÃO DE SOLUÇÃO DE PROBLEMAS:

Os valores padrão não aparecem na tabela de atributos dos parâmetros, mesmo quando eles são definidos na função ou no script. Para ajudar os usuários, liste o valor padrão na descrição do parâmetro.

Comentários:

A seção Remarks do tópico de ajuda é gerada automaticamente do nome da função ou do script. Você não pode alterar ou afetar seu conteúdo.

COMO DESABILITAR A AJUDA BASEADA EM COMENTÁRIOS

[Esta técnica foi uma sugestão de Rich Prescott, um engenheiro do Windows de Nova York, NY.]

Você pode desabilitar a ajuda baseada em comentários. Isso torna a ajuda baseada em comentários ineficiente, mas não a exclui.

Para desabilitar a ajuda baseada em comentários, coloque os comentários em uma cadeia de caracteres here. Para ocultar a cadeia de caracteres here, atribua-a a uma variável ou redirecione-a para o cmdlet Out-Null.

Enquanto ela estiver desabilitada, a ajuda baseada em comentários não terá nenhum efeito.

Por exemplo, a função a seguir tem a ajuda baseada em comentários.

            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.
            #>            
            function Add-Extension 
            {
                param ([string]$Name,[string]$Extension = "txt")
                ...
            } 

Para desabilitá-la, coloque-a em uma cadeia de caracteres here, conforme exibido no exemplo a seguir.

            @"  
            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.
            #>
            "@            
            function Add-Extension 
            {
                param ([string]$Name,[string]$Extension = "txt")
                ...
            }

Para ocultar a ajuda baseada em comentários e desabilitada, atribua a cadeia de caracteres here a uma variável local que não seja usada na função, conforme exibido no exemplo a seguir. Ele também pode redirecioná-la ao cmdlet Out-Null.

            $x = @"  
            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.
            #>
            "@            
            function Add-Extension 
            {
                param ([string]$Name,[string]$Extension = "txt")
                ...
            }

Para obter mais informações sobre cadeias de caractere here, consulte about_Quoting_Rules (https://go.microsoft.com/fwlink/?LinkID=113253).

EXEMPLOS

Exemplo 1: Ajuda baseada em comentários para uma função

A função de exemplo a seguir inclui a ajuda baseada em comentários:

            function Add-Extension 
            {
                param ([string]$Name,[string]$Extension = "txt")
                $name = $name + "." + $extension
                $name

            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.

            .DESCRIPTION
            Adds a file name extension to a supplied name. 
            Takes any strings for the file name or extension.

            .PARAMETER Name
            Specifies the file name.

            .PARAMETER Extension
            Specifies the extension. "Txt" is the default.

            .INPUTS
            None. You cannot pipe objects to Add-Extension.

            .OUTPUTS
            System.String. Add-Extension returns a string with the extension or file name.

            .EXAMPLE
            C:\PS> extension -name "File"
            File.txt

            .EXAMPLE
            C:\PS> extension -name "File" -extension "doc"
            File.doc

            .EXAMPLE
            C:\PS> extension "File" "doc"
            File.doc

            .LINK
            http://www.fabrikam.com/extension.html

            .LINK
            Set-Item
            #>
            }

Os resultados são os seguintes:

        C:\PS> get-help add-extension -full

        NAME
            Add-Extension
    
        SYNOPSIS
            Adds a file name extension to a supplied name.
    
        SYNTAX
            Add-Extension [[-Name] <String>] [[-Extension] <String>] [<CommonParameters>]
    
        DESCRIPTION
            Adds a file name extension to a supplied name. Takes any strings for the file name or extension.
    
        PARAMETERS
           -Name
               Specifies the file name.
        
               Required?                    false
               Position?                    0
               Default value                
               Accept pipeline input?       false
               Accept wildcard characters?  
        
           -Extension
               Specifies the extension. "Txt" is the default.
        
               Required?                    false
               Position?                    1
               Default value                
               Accept pipeline input?       false
               Accept wildcard characters?  
        
            <CommonParameters>
               This cmdlet supports the common parameters: -Verbose, -Debug,
               -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
               -OutBuffer and -OutVariable. For more information, type
               "get-help about_commonparameters".
            INPUTs
            None. You cannot pipe objects to Add-Extension.
        OUTPUTS
            System.String. Add-Extension returns a string with the extension or file name.
            -------------------------- EXAMPLE 1 --------------------------
    
            C:\PS> extension -name "File"
            File.txt
    
            -------------------------- EXAMPLE 2 --------------------------
    
            C:\PS> extension -name "File" -extension "doc"
            File.doc
    
            -------------------------- EXAMPLE 3 --------------------------
    
            C:\PS> extension "File" "doc"
            File.doc
    
        RELATED LINKS
            http://www.fabrikam.com/extension.html
            Set-Item

Exemplo 2: Descrições dos parâmetros na sintaxe da função

Este exemplo é igual ao anterior, com a exceção de que as descrições de parâmetro são inseridas na sintaxe da função. Esse formato é mais útil quando as descrições forem breves.

        function Add-Extension 
        {
            param 
            (
                [string]
                # Specifies the file name.
                $name,

                [string]
                # Specifies the file name extension. \"Txt\" is the default.
                $extension = "txt"
            )
            $name = $name + "." + $extension
            $name
      
            <#
            .SYNOPSIS 
            Adds a file name extension to a supplied name.

            .DESCRIPTION
            Adds a file name extension to a supplied name. Takes any strings for the file name or extension.

            .INPUTS
            None. You cannot pipe objects to Add-Extension.

            .OUTPUTS
            System.String. Add-Extension returns a string with the extension or file name.

            .EXAMPLE
            C:\PS> extension -name "File"
            File.txt

            .EXAMPLE
            C:\PS> extension -name "File" -extension "doc"
            File.doc

            .EXAMPLE
            C:\PS> extension "File" "doc"
            File.doc
 
            .LINK
            http://www.fabrikam.com/extension.html

            .LINK
            Set-Item
            #>
        }

Exemplo 3: Ajuda baseada em comentários para um script

O script de exemplo a seguir inclui a ajuda baseada em comentários.

Observe as linhas em branco entre o fechamento "#>" e a instrução Param. Em um script que não tenha uma instrução Param, deve haver pelo menos duas linhas em branco entre o comentário final do tópico de ajuda e a primeira declaração da função. Sem essas linhas em branco, o Get-Help associa o tópico de ajuda à função, não ao script.

           <#
           .SYNOPSIS 
           Performs monthly data updates.

           .DESCRIPTION
           The Update-Month.ps1 script updates the registry with new data generated
           during the past month and generates a report.
    
           .PARAMETER InputPath
           Specifies the path to the CSV-based input file.

           .PARAMETER OutputPath
           Specifies the name and path for the CSV-based output file. By default, 
           MonthlyUpdates.ps1 generates a name from the date and time it runs, and
           saves the output in the local directory.

           .INPUTS
           None. You cannot pipe objects to Update-Month.ps1.

           .OUTPUTS
           None. Update-Month.ps1 does not generate any output.

           .EXAMPLE
           C:\PS> .\Update-Month.ps1

           .EXAMPLE
           C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv

           .EXAMPLE
           C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath C:\Reports\2009\January.csv
           #>

           param ([string]$InputPath, [string]$OutPutPath)

           function Get-Data { }
           ...

O comando a seguir obtém a ajuda do script. Já que o script não está em um diretório listado na variável de ambiente Path, o comando Get-Help que obtém a ajuda do script deve especificar o caminho do script.

            PS C:\ps-test> get-help .\update-month.ps1 -full
            NAME
                C:\ps-test\Update-Month.ps1
            SYNOPSIS
                Performs monthly data updates.
            SYNTAX
                C:\ps-test\Update-Month.ps1 [-InputPath] <String> [[-OutputPath]
                <String>] [<CommonParameters>]
            DESCRIPTION
                The Update-Month.ps1 script updates the registry with new data
                generated during the past month and generates a report.
            PARAMETERS
               -InputPath
                   Specifies the path to the CSV-based input file.
        
                   Required?                    true
                   Position?                    0
                   Default value                
                   Accept pipeline input?       false
                   Accept wildcard characters?  
               -OutputPath
                   Specifies the name and path for the CSV-based output file. By
                   default, MonthlyUpdates.ps1 generates a name from the date
                   and time it runs, and saves the output in the local directory.
        
                   Required?                    false
                   Position?                    1
                   Default value                
                   Accept pipeline input?       false
                   Accept wildcard characters?  
               <CommonParameters>
                   This cmdlet supports the common parameters: -Verbose, -Debug,
                   -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
                   -OutBuffer and -OutVariable. For more information, type,
                   "get-help about_commonparameters".
            INPUTS
                   None. You cannot pipe objects to Update-Month.ps1.
            OUTPUTS
                   None. Update-Month.ps1 does not generate any output.
            -------------------------- EXAMPLE 1 --------------------------
        
            C:\PS> .\Update-Month.ps1
    
            -------------------------- EXAMPLE 2 --------------------------
       
            C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv
    
            -------------------------- EXAMPLE 3 --------------------------
    
            C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath 
            C:\Reports\2009\January.csv
        
            RELATED LINKS

Exemplo 4: Como fazer o redirecionamento para um arquivo XML

Você pode escrever tópicos de ajuda baseada em XML para funções e scripts. Embora a ajuda baseada em comentários seja mais fácil de implementar, a ajuda baseada em XML é necessária para a ajuda atualizável e para fornecer os tópicos de ajuda em vários idiomas.

O exemplo a seguir mostra as primeiras linhas do script Update-Month.ps1. O script usa a palavra-chave ExternalHelp para especificar o caminho para um tópico de ajuda baseada em XML para o script.

Observe que o valor da palavra-chave ExternalHelp aparece na mesma linha que a palavra-chave. Qualquer outro posicionamento é ineficaz.

            #  .ExternalHelp C:\MyScripts\Update-Month-Help.xml

            param ([string]$InputPath, [string]$OutPutPath)
            function Get-Data { }
            ...

O exemplo a seguir mostra três posicionamentos válidos da palavra-chave ExternalHelp em uma função.

function Add-Extension 
            {
                # .ExternalHelp C:\ps-test\Add-Extension.xml

                param ([string] $name, [string]$extension = "txt")
                $name = $name + "." + $extension
                $name
            }
            
            function Add-Extension 
            {
                param ([string] $name, [string]$extension = "txt")
                $name = $name + "." + $extension
                $name
      
                # .ExternalHelp C:\ps-test\Add-Extension.xml
            }

           # .ExternalHelp C:\ps-test\Add-Extension.xml
           function Add-Extension 
            {
                param ([string] $name, [string]$extension = "txt")
                $name = $name + "." + $extension
                $name
            }

Exemplo 5: Como fazer o redirecionando para um tópico de ajuda diferente

O código a seguir é um trecho do início da função integrada de ajuda do Windows PowerShell, que exibe uma tela de texto de ajuda de cada vez. Já que o tópico de ajuda do cmdlet Get-Help descreve a função de ajuda, esta usa as palavras-chave ForwardHelpTargetName e ForwardHelpCategory para redirecionar o usuário ao tópico de ajuda do cmdlet Get-Help.

            function help 
            {

            <#
            .FORWARDHELPTARGETNAME Get-Help
            .FORWARDHELPCATEGORY Cmdlet
            #>
            [CmdletBinding(DefaultParameterSetName='AllUsersView')]
            param(
                [Parameter(Position=0, ValueFromPipelineByPropertyName=$true)]
                [System.String]
                ${Name},
                   ...

O comando a seguir usa esse recurso:

            C:\PS> get-help help
            NAME
                Get-Help
            SYNOPSIS
                Displays information about Windows PowerShell cmdlets and concepts.
            ...

PALAVRAS-CHAVE

about_Comment-Based_Help

CONSULTE TAMBÉM

about_Functions

about_Functions_Advanced_Parameters

about_Scripts

"Como escrever a ajuda para cmdlets" (https://go.microsoft.com/fwlink/?LinkID=123415)