Come aggiungere una descrizione del cmdletHow to Add a Cmdlet Description

In questa sezione viene descritto come aggiungere contenuto che viene visualizzato nella sezione Descrizione della guida del cmdlet.This section describes how to add content that is displayed in the DESCRIPTION section of the cmdlet Help. Nel file della guida, questo contenuto viene aggiunto al nodo del comando per ogni cmdlet.In the Help file, this content is added to the Command node for each cmdlet.

Nota

Per una visualizzazione completa di un file della guida, aprire uno dei dll-Help.xml file disponibili nella directory di installazione di PowerShell.For a complete view of a Help file, open one of the dll-Help.xml files located in the PowerShell installation directory. Ad esempio, il Microsoft.PowerShell.Commands.Management.dll-Help.xml file contiene contenuto per diversi cmdlet di PowerShell.For example, the Microsoft.PowerShell.Commands.Management.dll-Help.xml file contains content for several of the PowerShell cmdlets.

Per aggiungere una descrizioneTo Add a Description

  • Per iniziare, è necessario illustrare in modo più dettagliato le funzionalità di base del cmdlet.Begin by explaining the basic features of the cmdlet in more detail. In molti casi, è possibile spiegare i termini usati nel nome del cmdlet e illustrare concetti non noti con un esempio.In many cases, you can explain the terms used in the cmdlet name and illustrate unfamiliar concepts with an example. Se, ad esempio, il cmdlet aggiunge dati a un file, spiega che aggiunge dati alla fine di un file esistente.For example, if the cmdlet appends data to a file, explain that it adds data to the end of an existing file.

  • Per trovare tutte le funzionalità del cmdlet, esaminare l'elenco dei parametri.To find all of the features of the cmdlet, review the parameter list. Descrivere la funzione principale del cmdlet e quindi includere altre funzioni e funzionalità.Describe the primary function of the cmdlet, and then include other functions and features. Se, ad esempio, la funzione principale del cmdlet è la modifica di una proprietà, ma il cmdlet può modificare tutte le proprietà, ad esempio nella descrizione dettagliata.For example, if the main function of the cmdlet is to change one property, but the cmdlet can change all of the properties, say so in the detailed description. Se i parametri del cmdlet consentono agli utenti di richiedere informazioni in modi diversi, spiegarlo.If the cmdlet parameters let the users solicit information in different ways, explain it.

  • Includere informazioni sui modi in cui gli utenti possono utilizzare il cmdlet, oltre agli utilizzi più evidenti.Include information on ways that users can use the cmdlet, in addition to the obvious uses. Ad esempio, è possibile usare l'oggetto recuperato dal Get-Host cmdlet per modificare il colore del testo nella finestra di comando di Windows PowerShell.For example, you can use the object that the Get-Host cmdlet retrieves to change the color of text in the Windows PowerShell command window.

    Esempio: "il Get-Acl cmdlet ottiene gli oggetti che rappresentano il descrittore di sicurezza di un file o di una risorsa.Example: "The Get-Acl cmdlet gets objects that represent the security descriptor of a file or resource. Il descrittore di sicurezza contiene gli elenchi di controllo di accesso della risorsa.The security descriptor contains the access control lists (ACLs) of the resource. L'ACL specifica le autorizzazioni che gli utenti e i gruppi di utenti devono accedere alla risorsa ".The ACL specifies the permissions that users and user groups have to access the resource."

  • La descrizione dettagliata dovrebbe descrivere il cmdlet, ma non deve descrivere i concetti usati dal cmdlet.The detailed description should describe the cmdlet, but it should not describe concepts that the cmdlet uses. Inserire le definizioni dei concetti in note aggiuntive.Place concept definitions in Additional Notes.

Vedere ancheSee Also

Windows PowerShell SDKWindows PowerShell SDK