about_Comment_Based_Help

Aggiornamento: maggio 2014

Si applica a: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0, Windows PowerShell 5.0

Inserire l'introduzione qui.

ARGOMENTO

about_Comment_Based_Help

DESCRIZIONE BREVE

Illustra come scrivere gli argomenti della Guida basata su commenti per funzioni e script.

DESCRIZIONE LUNGA

Per scrivere gli argomenti della Guida basata su commenti per funzioni e script, usare le parole chiave speciali per il commento della Guida.

Il cmdlet Get-Help visualizza la Guida basata su commenti nello stesso formato degli argomenti della Guida del cmdlet generati dai file XML. Gli utenti possono usare tutti i parametri di Get-Help, ad esempio Detailed, Full, Example e Online, per visualizzare il contenuto della Guida basata su commenti.

È anche possibile scrivere i file della Guida basata su XML per le funzioni e gli script. Per abilitare il cmdlet Get-Help per la ricerca del file della Guida basata su XML per una funzione o uno script, usare la parola chiave ExternalHelp. Senza questa parola chiave, Get-Help non riesce a trovare gli argomenti della Guida basata su XML per le funzioni o gli script.

Questo argomento spiega come scrivere gli argomenti della Guida per le funzioni e gli script. Per informazioni su come visualizzare gli argomenti della Guida per le funzioni e gli script, vedere Get-Help.

NOTA:

i cmdlet Update-Help e Save-Help funzionano solo in file XML. La Guida aggiornabile non supporta gli argomenti della Guida basata su commenti.

NOTA SULLA RISOLUZIONE DEI PROBLEMI:

i valori predefiniti e il valore per "Accettare i caratteri jolly" non vengono visualizzati nella tabella di attributi del parametro anche quando sono definiti nella funzione o nello script. Per aiutare gli utenti, fornire queste informazioni nella descrizione del parametro.

SINTASSI PER LA GUIDA BASATA SU COMMENTI

La sintassi per la Guida basata su commenti è la seguente:

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

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

La Guida basata su commenti viene scritta come una serie di commenti. È possibile digitare un simbolo di commento (#) prima di ogni riga di commento oppure usare i simboli "<#" e "#>" per creare un blocco di commento. Tutte le righe all'interno del blocco di commento vengono interpretate come commenti.

Tutte le righe in un argomento della Guida basata su commenti devono essere contigue. Se un argomento della Guida basata su commenti segue un commento che non fa parte dell'argomento della Guida, deve esistere almeno una riga vuota tra l'ultima riga di commento non inclusa nella Guida e l'inizio della Guida basata su commenti.

Le parole chiave definiscono ogni sezione della Guida basati su commenti. Ogni parola chiave della Guida basata su commenti è preceduta da un punto (.). Le parole chiave possono essere visualizzate in qualsiasi ordine. I nomi delle parole chiave non fanno distinzione tra maiuscole e minuscole.

Ad esempio, la parola chiave Description precede la descrizione di una funzione o di uno script.

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

Il blocco di commento deve contenere almeno una parola chiave. Alcune parole chiave, come EXAMPLE, possono essere visualizzate più volte nello stesso blocco di commento. Il contenuto della Guida per ogni parola chiave inizia dalla riga dopo la parola chiave e può estendersi su più righe.

SINTASSI PER LA GUIDA BASATA SU COMMENTI NELLE FUNZIONI

La Guida per una funzione basata su commenti può essere visualizzata in uno di questi tre percorsi:

        -- 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.

Ad esempio:

        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 { }

SINTASSI PER LA GUIDA BASATA SU COMMENTI NEGLI SCRIPT

La Guida per uno script basata su commenti può essere visualizzata in uno dei due percorsi seguenti nello 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.

Ad esempio:

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


        function Get-Function { }

    -or-


        function Get-Function { }

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

SINTASSI PER LA GUIDA BASATA SU COMMENTI NEI MODULI DI SCRIPT

In un modulo di script (psm1) la Guida basata su commenti usa la sintassi per le funzioni, non la sintassi per gli script. Non è possibile usare la sintassi dello script per fornire una Guida per tutte le funzioni definite in un modulo di script.

Ad esempio, se si usa la parola chiave ExternalHelp per identificare i file della Guida basata su XML per le funzioni in un modulo di script, è necessario aggiungere un commento ExternalHelp a ogni funzione.

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

PAROLE CHIAVE DELLA GUIDA BASATA SU COMMENTI

Di seguito sono elencate le parole chiave valide della Guida basata su commenti. Sono elencate, insieme all'utilizzo previsto, nell'ordine con cui vengono visualizzate di solito in un argomento della Guida. Queste parole chiave possono essere visualizzate in qualsiasi ordine nella Guida basata su commenti e non distinguono tra maiuscole e minuscole.

.SYNOPSIS

Breve descrizione della funzione o dello script. Questa parola chiave può essere usata una sola volta in ogni argomento.

.DESCRIPTION

Descrizione dettagliata della funzione o dello script. Questa parola chiave può essere usata una sola volta in ogni argomento.

.PARAMETER <Parameter-Name>

Descrizione di un parametro. Aggiungere una parola chiave .PARAMETER per ogni parametro nella sintassi della funzione o dello script.

Digitare il nome del parametro nella stessa riga della parola chiave .PARAMETER. Digitare la descrizione del parametro nelle righe successive alla parola chiave .PARAMETER. Windows PowerShell interpreta tutto il testo tra la riga .PARAMETER e la parola chiave successiva o la fine del blocco di commento come parte della descrizione del parametro. La descrizione può includere interruzioni di paragrafo.

Le parole chiave Parameter possono essere visualizzate in qualsiasi ordine nel blocco di commento, ma la sintassi della funzione o dello script determina l'ordine con cui i parametri (e le relative descrizioni) vengono visualizzati nell'argomento della Guida. Per modificare l'ordine, modificare la sintassi.

È anche possibile specificare una descrizione del parametro inserendo un commento nella sintassi della funzione o dello script subito prima del nome della variabile del parametro. Se si usa un commento di sintassi e una parola chiave Parameter, viene usata la descrizione associata alla parola chiave Parameter, mentre il commento di sintassi viene ignorato.

.EXAMPLE

Comando di esempio che usa la funzione o lo script, seguito facoltativamente da un output di esempio e una descrizione. Ripetere questa parola chiave per ogni esempio.

.INPUTS

Tipi di oggetti che possono essere trasmesse alla funzione o uno script di Microsoft .NET Framework. È anche possibile includere una descrizione degli oggetti di input.

.OUTPUTS

Tipo .NET Framework degli oggetti restituiti dal cmdlet. È anche possibile includere una descrizione degli oggetti restituiti.

.NOTES

Altre informazioni sulla funzione o sullo script.

Nome di un argomento correlato. Il valore viene visualizzato nella riga sotto la parola chiave .LINE e deve essere preceduto da un simbolo di commento (#) o incluso nel blocco di commento.

Ripetere la parola chiave .LINK per ogni argomento correlato.

Questo contenuto viene visualizzato nella sezione Collegamenti correlati dell'argomento della Guida.

Il contenuto della parola chiave Link può includere anche un URI (Uniform Resource Identifier) per una versione online dello stesso argomento della Guida. La versione online viene visualizzata quando si usa il parametro Online di Get-Help. L'URI deve iniziare con "HTTP" o "HTTPS".

.COMPONENT

Tecnologia o funzionalità usata o a cui fa riferimento la funzione o lo script. Questo contenuto viene visualizzato quando il comando Get-Help include il parametro Component di Get-Help.

.ROLE

Ruolo utente per l'argomento della Guida. Questo contenuto viene visualizzato quando il comando Get-Help include il parametro Role di Get-Help.

.FUNCTIONALITY

Uso previsto della funzione. Questo contenuto viene visualizzato quando il comando Get-Help include il parametro Functionality di Get-Help.

.FORWARDHELPTARGETNAME <Command-Name>

Reindirizza all'argomento della Guida per il comando specificato. È possibile reindirizzare gli utenti a qualsiasi argomento della Guida, inclusi gli argomenti relativi a una funzione, uno script, un cmdlet o un provider.

.FORWARDHELPCATEGORY <Category>

Specifica la categoria della Guida per l'elemento in ForwardHelpTargetName. I valori validi sono Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filter o All. Usare questa parola chiave per evitare conflitti quando sono presenti comandi con lo stesso nome.

.REMOTEHELPRUNSPACE <PSSession-variable>

Specifica una sessione che contiene l'argomento della Guida. Immettere una variabile che contiene PSSession. Questa parola chiave viene usata dal cmdlet Export-PSSession per trovare gli argomenti della Guida per i comandi esportati.

.EXTERNALHELP <XML Help File>

Specifica un file della Guida basata su XML per lo script o la funzione.

La parola chiave ExternalHelp è necessaria quando una funzione o uno script è documentato nei file XML. Senza questa parola chiave, Get-Help non riesce a trovare il file della Guida basata su XML per la funzione o lo script.

La parole chiave ExternalHelp ha la precedenza rispetto alle altre parole chiave della Guida basata su commenti. Se è presente ExternalHelp, Get-Help non visualizza la Guida basata su commenti, anche se non riesce a trovare un argomento della Guida che corrisponde al valore della parola chiave ExternalHelp.

Se la funzione viene esportata da un modulo, impostare il valore della parola chiave ExternalHelp su un nome file senza percorso. Get-Help cerca il nome file specificato in una sottodirectory specifica della lingua della directory del modulo. Non ci sono requisiti per il nome del file della Guida basata su XML per una funzione, ma si consiglia di usare il formato seguente:

        <ScriptModule.psm1>-help.xml

Se la funzione non è contenuta in un modulo, includere un percorso al file della Guida basata su XML. Se il valore include un percorso e il percorso contiene sottodirectory specifiche delle impostazioni cultura dell'interfaccia utente, Get-Help esegue una ricerca ricorsiva nelle sottodirectory per individuare un file XML con il nome dello script o della funzione conformemente agli standard di fallback per la lingua stabiliti per Windows, come accade in una directory del modulo.

Per altre informazioni sul formato di file della Guida basata su XML per i cmdlet, vedere "Come creare una Guida del cmdlet" nella libreria MSDN (Microsoft Developer Network) all'indirizzo https://go.microsoft.com/fwlink/?LinkID=123415.

CONTENUTO GENERATO AUTOMATICAMENTE

Il nome, la sintassi, l'elenco di parametri, la tabella di attributi del parametro, i parametri comuni e le osservazioni vengono generati automaticamente dal cmdlet Get-Help.

Nome:

La sezione del nome di un argomento della Guida relativa alle funzioni viene acquisita dal nome della funzione nella sintassi della funzione. Il nome di un argomento della Guida relativo agli script viene acquisito dal nome del file di script. Per modificare il nome o l'uso delle maiuscole e delle minuscole, modificare la sintassi della funzione o il nome del file di script.

Sintassi:

La sezione della sintassi di un argomento della Guida viene generata dalla sintassi della funzione o dello script. Per aggiungere dettagli alla sintassi dell'argomento della Guida, ad esempio il tipo .NET Framework di un parametro, aggiungere i dettagli alla sintassi. Se non si specifica un tipo di parametro, il tipo "Object" viene inserito come valore predefinito.

Elenco di parametri:

L'elenco di parametri nell'argomento della Guida viene generato dalla sintassi della funzione o dello script e dalle descrizioni aggiunte tramite la parola chiave Parameters. I parametri della funzione vengono visualizzati nella sezione relativa ai parametri dell'argomento della Guida nello stesso ordine con cui vengono visualizzati nella sintassi della funzione o dello script. Anche l'ortografia e l'uso delle maiuscole e delle minuscole per i nomi di parametro vengono acquisiti dalla sintassi. Non vengono interessati dal nome del parametro specificato dalla parola chiave Parameter.

Parametri comuni:

I parametri comuni vengono aggiunti alla sintassi e all'elenco di parametri dell'argomento della Guida anche se non hanno alcun effetto. Per altre informazioni sui parametri comuni, vedere about_CommonParameters.

Tabella di attributi del parametro:

Get-Help genera la tabella di attributi del parametro visualizzata quando si usa il parametro Full o Parameter di Get-help. Il valore degli attributi Required, Position e Default del valore viene acquisito dalla sintassi della funzione o dello script.

NOTA SULLA RISOLUZIONE DEI PROBLEMI:

I valori predefiniti non vengono visualizzati nella tabella di attributi del parametro anche quando sono definiti nella funzione o nello script. Per aiutare gli utenti, elencare il valore predefinito nella descrizione del parametro.

Osservazioni:

La sezione delle osservazioni dell'argomento della Guida viene generata automaticamente dal nome della funzione o dello script. Non è possibile modificare o influire sul contenuto.

DISABILITAZIONE DELLA GUIDA BASATA SU COMMENTI

[Questa tecnica è stata suggerita da Rich Prescott, un tecnico di Windows di New York, NY.]

La Guida basata su commenti può essere disabilitata. In questo modo è possibile disattivare la Guida basata su commenti senza eliminarla.

Per disabilitare la Guida basata su commenti, racchiudere i commenti in una stringa di tipo here. Per nascondere la stringa, assegnarla a una variabile o inviarla tramite pipe al cmdlet Out-Null.

Quando è disabilitata, la Guida basata su commenti non ha alcun effetto.

Ad esempio, la funzione seguente include la Guida basata su commenti.

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

Per disabilitare la Guida basata su commenti, racchiuderla in una stringa di tipo here, come illustrato nell'esempio seguente.

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

Per nascondere la Guida basata su commenti disabilitata, assegnare la stringa di tipo here a una variabile locale non usata nella funzione, come illustrato nell'esempio seguente. È anche possibile inviarla tramite pipe al cmdlet Out-Null.

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

Per altre informazioni sulle stringhe di tipo here, vedere about_Quoting_Rules (https://go.microsoft.com/fwlink/?LinkID=113253).

ESEMPI

Esempio 1: guida per una funzione basata su commenti

La funzione di esempio seguente include la Guida basata su commenti:

            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
            #>
            }

I risultati sono i seguenti:

        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

Esempio 2: descrizioni dei parametri nella sintassi della funzione

Questo esempio è identico a quello precedente, a eccezione del fatto che le descrizioni dei parametri vengono inserite nella sintassi della funzione. Questo formato è particolarmente utile quando le descrizioni sono brevi.

        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
            #>
        }

Esempio 3: guida per uno script basata su commenti

Lo script di esempio seguente include la Guida basata su commenti.

Notare le righe vuote tra "#>" di chiusura e l'istruzione Param. In uno script senza l'istruzione Param devono esserci almeno due righe vuote tra il commento finale nell'argomento della Guida e la prima dichiarazione di funzione. Senza queste righe vuote, Get-Help associa l'argomento della Guida alla funzione, non allo 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 { }
           ...

Il comando seguente ottiene la Guida dello script. Poiché lo script non è presente in una directory elencata nella variabile di ambiente Path, il comando Get-Help che ottiene la Guida dello script deve specificare il percorso dello 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

Esempio 4: reindirizzamento a un file XML

È possibile scrivere gli argomenti della Guida basata su XML per le funzioni e gli script. Anche se la Guida basata su commenti è più facile da implementare, la Guida basata su XML è necessaria per la Guida aggiornabile e per fornire gli argomenti della Guida in più lingue.

L'esempio seguente mostra le prime righe dello script Update-Month.ps1. Lo script usa la parola chiave ExternalHelp per specificare il percorso di un argomento della Guida basata su XML per lo script.

Il valore della parola chiave ExternalHelp viene visualizzato nella stessa riga della parola chiave. Le altre posizioni non sono valide.

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

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

L'esempio seguente mostra tre posizioni valide della parola chiave ExternalHelp in una funzione.

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
            }

Esempio 5: reindirizzamento a un altro argomento della Guida

Il codice seguente è un estratto della parte iniziale della funzione predefinita della Guida in Windows PowerShell, che visualizza una schermata di testo della Guida alla volta. Poiché l'argomento della Guida del cmdlet Get-Help descrive la funzione Help, questa usa le parole chiave ForwardHelpTargetName e ForwardHelpCategory per reindirizzare l'utente all'argomento della Guida del cmdlet Get-Help.

            function help 
            {

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

Il comando seguente usa questa funzionalità:

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

PAROLE CHIAVE

about_Comment-Based_Help

VEDERE ANCHE

about_Functions

about_Functions_Advanced_Parameters

about_Scripts

"Come scrivere una Guida del cmdlet" (https://go.microsoft.com/fwlink/?LinkID=123415)