Jak dodać opis polecenia cmdletHow to Add a Cmdlet Description

W tej sekcji opisano, jak dodać zawartość, która jest wyświetlana w sekcji Opis w pomocy polecenia cmdlet.This section describes how to add content that is displayed in the DESCRIPTION section of the cmdlet Help. W pliku pomocy ta zawartość jest dodawana do węzła poleceń dla każdego polecenia cmdlet.In the Help file, this content is added to the Command node for each cmdlet.

Uwaga

Aby uzyskać pełny wgląd w plik pomocy, otwórz jeden z dll-Help.xml plików znajdujących się w katalogu instalacyjnym programu PowerShell.For a complete view of a Help file, open one of the dll-Help.xml files located in the PowerShell installation directory. Na przykład Microsoft.PowerShell.Commands.Management.dll-Help.xml plik zawiera zawartość dla kilku poleceń cmdlet programu PowerShell.For example, the Microsoft.PowerShell.Commands.Management.dll-Help.xml file contains content for several of the PowerShell cmdlets.

Aby dodać opisTo Add a Description

  • Zacznij od wyjaśnienia podstawowych funkcji polecenia cmdlet w bardziej szczegółowy sposób.Begin by explaining the basic features of the cmdlet in more detail. W wielu przypadkach można wyjaśnić terminy użyte w nazwie polecenia cmdlet i zilustrować nieznane koncepcje przy użyciu przykładu.In many cases, you can explain the terms used in the cmdlet name and illustrate unfamiliar concepts with an example. Na przykład jeśli polecenie cmdlet dołącza dane do pliku, Wyjaśnij, że dodaje dane na końcu istniejącego pliku.For example, if the cmdlet appends data to a file, explain that it adds data to the end of an existing file.

  • Aby znaleźć wszystkie funkcje polecenia cmdlet, zapoznaj się z listą parametrów.To find all of the features of the cmdlet, review the parameter list. Opisz podstawową funkcję polecenia cmdlet, a następnie Dołącz inne funkcje i funkcje.Describe the primary function of the cmdlet, and then include other functions and features. Na przykład, jeśli główną funkcją polecenia cmdlet jest zmiana jednej właściwości, ale polecenie cmdlet może zmienić wszystkie właściwości, powiedzmy w szczegółowym opisie.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. Jeśli parametry polecenia cmdlet umożliwiają użytkownikom żądanie informacji na różne sposoby, wyjaśnij ją.If the cmdlet parameters let the users solicit information in different ways, explain it.

  • Dołączanie informacji na temat sposobów, w których użytkownicy mogą korzystać z polecenia cmdlet, oprócz oczywistych użycia.Include information on ways that users can use the cmdlet, in addition to the obvious uses. Na przykład można użyć obiektu, który Get-Host polecenie cmdlet pobiera do zmiany koloru tekstu w oknie wiersza polecenia programu 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.

    Przykład: " Get-Acl polecenie cmdlet pobiera obiekty reprezentujące deskryptor zabezpieczeń pliku lub zasobu.Example: "The Get-Acl cmdlet gets objects that represent the security descriptor of a file or resource. Deskryptor zabezpieczeń zawiera listy kontroli dostępu (ACL) zasobu.The security descriptor contains the access control lists (ACLs) of the resource. Lista ACL określa uprawnienia, które użytkownicy i grupy użytkowników muszą uzyskać dostęp do zasobu ".The ACL specifies the permissions that users and user groups have to access the resource."

  • Szczegółowy opis powinien opisywać polecenie cmdlet, ale nie powinien opisywać koncepcji używanych przez polecenie cmdlet.The detailed description should describe the cmdlet, but it should not describe concepts that the cmdlet uses. Umieść definicje koncepcji w dodatkowych notatkach.Place concept definitions in Additional Notes.

Zobacz teżSee Also

Windows PowerShell SDKWindows PowerShell SDK