Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
In questa sezione viene descritto come aggiungere il contenuto visualizzato nella sezione DESCRIPTION della Guida del cmdlet. Nel file della Guida questo contenuto viene aggiunto al nodo Comando per ogni cmdlet.
Nota
Per una visualizzazione completa di un file della Guida, aprire uno dei dll-Help.xml file presenti nella directory di installazione di PowerShell. Ad esempio, il Microsoft.PowerShell.Commands.Management.dll-Help.xml file contiene il contenuto per diversi cmdlet di PowerShell.
Per aggiungere una descrizione
Per iniziare, illustrare le funzionalità di base del cmdlet in modo più dettagliato. In molti casi, è possibile spiegare i termini usati nel nome del cmdlet e illustrare concetti sconosciuti con un esempio. Ad esempio, se il cmdlet aggiunge dati a un file, spiegare che aggiunge dati alla fine di un file esistente.
Per trovare tutte le funzionalità del cmdlet, esaminare l'elenco dei parametri. Descrivere la funzione primaria del cmdlet e quindi includere altre funzioni e funzionalità. Ad esempio, se la funzione principale del cmdlet è modificare una proprietà, ma il cmdlet può modificare tutte le proprietà, ad esempio nella descrizione dettagliata. Se i parametri del cmdlet consentono agli utenti di chiedere informazioni in modi diversi, spiegarlo.
Includere informazioni sui modi in cui gli utenti possono usare il cmdlet, oltre agli usi ovvi. Ad esempio, è possibile usare l'oggetto recuperato dal cmdlet per modificare il colore del testo nella finestra Windows PowerShell
Get-Hostcomando.Esempio: "Il
Get-Aclcmdlet ottiene oggetti che rappresentano il descrittore di sicurezza di un file o di una risorsa. Il descrittore di sicurezza contiene gli elenchi di controllo di accesso della risorsa. L'elenco di controllo di accesso specifica le autorizzazioni che gli utenti e i gruppi di utenti hanno per accedere alla risorsa."La descrizione dettagliata deve descrivere il cmdlet, ma non i concetti utilizzati dal cmdlet. Inserire le definizioni dei concetti in Note aggiuntive.