Jak dodać opis polecenia cmdlet

W tej sekcji opisano sposób dodawania zawartości wyświetlanej w sekcji OPIS pomocy polecenia cmdlet. W pliku Pomocy ta zawartość jest dodawana do węzła Polecenia dla każdego polecenia cmdlet.

Uwaga

Aby uzyskać pełny widok pliku Pomocy, otwórz jeden z plików znajdujących dll-Help.xml się w katalogu instalacyjnym programu PowerShell. Na przykład plik Microsoft.PowerShell.Commands.Management.dll-Help.xml zawiera zawartość kilku poleceń cmdlet programu PowerShell.

Aby dodać opis

• Zacznij od bardziej szczegółowego objaśnienia podstawowych funkcji polecenia cmdlet. W wielu przypadkach można wyjaśnić terminy używane w nazwie polecenia cmdlet i zilustrować nieznane pojęcia na przykładzie. Jeśli na przykład polecenie cmdlet dołącza dane do pliku, wyjaśnij, że dane są dodawane na końcu istniejącego pliku.

• Aby znaleźć wszystkie funkcje polecenia cmdlet, przejrzyj listę parametrów. Opisz podstawową funkcję polecenia cmdlet, a następnie dołącz inne funkcje i funkcje. Jeśli na przykład główną funkcją polecenia cmdlet jest zmiana jednej właściwości, ale polecenie cmdlet może zmienić wszystkie właściwości, np. w szczegółowym opisie. Jeśli parametry polecenia cmdlet umożliwiają użytkownikom na żądanie informacji na różne sposoby, wyjaśnij je.

• Dołącz informacje o sposobach, w jakie użytkownicy mogą używać polecenia cmdlet, oprócz oczywistych zastosowań. Na przykład można użyć obiektu pobieranego przez polecenie cmdlet, aby zmienić kolor tekstu w Get-Host oknie Windows PowerShell polecenia.

  Przykład: "Polecenie Get-Acl cmdlet pobiera obiekty reprezentujące deskryptor zabezpieczeń pliku lub zasobu. Deskryptor zabezpieczeń zawiera listy kontroli dostępu (ACL) zasobu. Listy ACL określają uprawnienia, które użytkownicy i grupy użytkowników mają dostęp do zasobu."

• Szczegółowy opis powinien opisywać polecenie cmdlet, ale nie powinno opisywać pojęć, których używa polecenie cmdlet. Umieść definicje koncepcji w dodatkowych uwagach.

Zobacz też

Windows PowerShell SDK