Condividi tramite

parole chiave della Guida Comment-Based

  • Articolo

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 di oggetti di Microsoft .NET Framework che possono essere inviati tramite pipe alla funzione o allo script. È 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

Informazioni aggiuntive sulla funzione o sullo script.

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, inclusi gli argomenti della Guida per una funzione, uno script, un cmdlet o un provider.

.FORWARDHELPCATEGORY <Category>

Specifica la categoria della Guida dell'elemento in .FORWARDHELPTARGETNAME. Usare questa parola chiave per evitare conflitti quando sono presenti comandi con lo stesso nome.

I valori validi sono:

  • Alias
  • Cmdlet
  • HelpFile
  • Function
  • Provider
  • General
  • FAQ
  • Glossary
  • ScriptCommand
  • ExternalScript
  • Filtro
  • Tutto

.REMOTEHELPRUNSPACE <PSSession-variable>

Specifica una sessione contenente l'argomento della Guida. Immettere una variabile contenente una sessione 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 il percorso e/o il nome di un file della Guida basato su XML per lo script o la funzione.

La parola chiave .EXTERNALHELP indica al cmdlet Get-Help per ottenere assistenza per lo script o la funzione in un file basato su XML. La parola chiave .EXTERNALHELP è necessaria quando si usa un file della Guida basato su XML per uno script o una funzione. Senza di esso, Get-Help non troverà un file della Guida per la funzione o lo script.

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.

Quando la funzione viene esportata da un modulo script, il valore di .EXTERNALHELP deve essere un nome file senza un percorso. Get-Help cerca il file in una sottodirectory specifica delle impostazioni locali della directory del modulo. Non sono previsti requisiti per il nome file, ma è consigliabile usare il formato di nome file seguente: <ScriptModule>.psm1-help.xml.

Quando la funzione non è associata a un modulo, includere un percorso e un nome file nel valore della parola chiave .EXTERNALHELP. Se il percorso specificato del file XML contiene sottodirectory specifiche delle impostazioni cultura dell'interfaccia utente, Get-Help cerca in modo ricorsivo un file XML con il nome dello script o della funzione in base agli standard di fallback del linguaggio stabiliti per Windows, proprio come per tutti gli argomenti della Guida basata su XML.

Per altre informazioni sul formato del file della Guida basata su XML della Guida, vedere Writing Windows PowerShell Cmdlet Help.For more information about the cmdlet help help xml-based help, see Writing Windows PowerShell Cmdlet Help.