parole chiave della Guida Comment-Based

In questo argomento vengono elencate e descritte le parole chiave nella Guida basata su commenti.

Parole chiave nella Guida di Comment-Based

Di seguito sono riportate le parole chiave della Guida basate su commenti valide. Vengono elencati nell'ordine in cui vengono in genere visualizzati in un argomento della Guida insieme all'uso previsto. Queste parole chiave possono essere visualizzate in qualsiasi ordine nella Guida basata su commenti e non fanno distinzione tra maiuscole e minuscole.

Si noti che la parola chiave .EXTERNALHELP ha la precedenza su tutte le altre parole chiave della Guida basata su commenti. Quando è presente, il cmdlet Get-Help non visualizza la Guida basata su commenti, anche quando non riesce a trovare un file della Guida corrispondente al valore della parola chiave.

.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. È possibile includere una parola chiave .PARAMETER per ogni parametro nella funzione o nello script.

Le parole chiave .PARAMETER possono essere visualizzate in qualsiasi ordine nel blocco di commenti, ma l'ordine in cui i parametri vengono visualizzati nell'istruzione o nella dichiarazione di funzione param determina l'ordine in cui i parametri vengono visualizzati nell'argomento della Guida. Per modificare l'ordine dei parametri nell'argomento della Guida, modificare l'ordine dei parametri nella dichiarazione di param istruzione o funzione.

È anche possibile specificare una descrizione del parametro inserendo un commento nell'istruzione param immediatamente prima del nome della variabile del parametro. Se si usano sia un commento dell'istruzione param che una parola chiave .PARAMETER, viene usata la descrizione associata alla parola chiave .PARAMETER e il commento dell'istruzione param viene ignorato.

.EXAMPLE

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

.INPUTS

Tipi .NET di oggetti che possono essere inviati tramite pipe alla funzione o allo script. È anche possibile includere una descrizione degli oggetti di input. Ripetere questa parola chiave per ogni tipo di input.

.OUTPUTS

Tipo .NET degli oggetti restituiti dal cmdlet. È anche possibile includere una descrizione degli oggetti restituiti. Ripetere questa parola chiave per ogni tipo di output.

.NOTES

Informazioni aggiuntive sulla funzione o sullo script.

.LINK

Nome di un argomento correlato. Ripetere questa parola chiave 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) in una versione online dello stesso argomento della Guida. La versione online viene aperta quando si usa il parametro Online di Get-Help. L'URI deve iniziare con http o https.

.COMPONENT

Nome della tecnologia o della funzionalità usata dalla funzione o dallo script o da cui è correlata. Il parametro Component di Get-Help usa questo valore per filtrare i risultati della ricerca restituiti da Get-Help.

.ROLE

Nome del ruolo utente per l'argomento della Guida. Il parametro Role di Get-Help usa questo valore per filtrare i risultati della ricerca restituiti da Get-Help.

.FUNCTIONALITY

Parole chiave che descrivono l'uso previsto della funzione. Il parametro Functionality di Get-Help usa questo valore per filtrare i risultati della ricerca restituiti da Get-Help.

.FORWARDHELPTARGETNAME <Command-Name>

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

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

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

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

Specifica una sessione contenente l'argomento della Guida. Immettere una variabile contenente un oggetto PSSession. Questa parola chiave viene usata dal cmdlet [Export-PSSession][09] per trovare il contenuto della Guida per i comandi esportati.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Specifica un file di aiuto basato su XML per lo script o la funzione.

# .EXTERNALHELP <XML Help File>

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 di aiuto basato su XML per la funzione o lo script.

La parola chiave .EXTERNALHELP ha la precedenza su altre parole chiave della Guida basate su commenti. Se .EXTERNALHELP è presente, Get-Help non visualizza la Guida basata su commenti, anche se non riesce a trovare un argomento della Guida corrispondente 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 un percorso. Get-Help cerca il nome file specificato in una sottodirectory specifica della lingua della directory del modulo. Non sono previsti requisiti per il nome del file della Guida basato su XML per una funzione. A partire da PowerShell 5.0, le funzioni esportate da un modulo possono essere documentate in un file della Guida denominato per il modulo. Non è necessario usare la .EXTERNALHELP parola chiave comment. Ad esempio, se la Test-Function funzione viene esportata dal MyModule modulo, è possibile denominare il file MyModule-help.xmldella Guida . Il Get-Help cmdlet cerca la Guida per la Test-Function funzione nel MyModule-help.xml file nella directory del modulo.

Se la funzione non è inclusa in un modulo, includere un percorso al file di guida basato su XML. Se il valore include un percorso e il percorso contiene sottodirectory specifiche della cultura dell'interfaccia utente, Get-Help cerca nelle sottodirectory in modo ricorsivo un file XML con il nome dello script o della funzione in conformità con gli standard di fallback linguistico stabiliti per Windows, proprio come avviene in una directory del modulo.

Per ulteriori informazioni sul formato di file della Guida del cmdlet basata su XML, vedere Come scrivere la Guida del Cmdlet.