słowa kluczowe pomocy Comment-Based

W tym temacie wymieniono i opisano słowa kluczowe w pomocy opartej na komentarzach.

Słowa kluczowe w pomocy Comment-Based

Poniżej znajdują się prawidłowe słowa kluczowe Pomocy oparte na komentarzach. Są one wymienione w kolejności, w której zazwyczaj pojawiają się w temacie Pomocy wraz z ich zamierzonym użyciem. Te słowa kluczowe mogą być wyświetlane w dowolnej kolejności w pomocy opartej na komentarzach i nie są uwzględniane wielkości liter.

Należy pamiętać, że słowo kluczowe .EXTERNALHELP ma pierwszeństwo przed wszystkimi innymi słowami kluczowymi pomocy opartymi na komentarzach. Gdy .EXTERNALHELP jest obecny, polecenie cmdlet Get-Help nie wyświetla pomocy opartej na komentarzach, nawet jeśli nie może znaleźć pliku pomocy zgodnego z wartością słowa kluczowego.

.SYNOPSIS

Krótki opis funkcji lub skryptu. To słowo kluczowe może być używane tylko raz w każdym temacie.

.DESCRIPTION

Szczegółowy opis funkcji lub skryptu. To słowo kluczowe może być używane tylko raz w każdym temacie.

.PARAMETER <Parameter-Name>

Opis parametru. Dla każdego parametru funkcji lub skryptu można dołączyć słowo kluczowe .PARAMETER.

Słowa kluczowe .PARAMETER mogą pojawiać się w dowolnej kolejności w bloku komentarza, ale kolejność wyświetlania parametrów w instrukcji Param lub deklaracji funkcji określa kolejność wyświetlania parametrów w temacie Pomocy. Aby zmienić kolejność parametrów w temacie Pomoc, zmień kolejność parametrów w instrukcji Param lub deklaracji funkcji.

Można również określić opis parametru, umieszczając komentarz w instrukcji Param bezpośrednio przed nazwą zmiennej parametru. Jeśli używasz zarówno komentarza instrukcji Param, jak i słowa kluczowego .PARAMETER, zostanie użyty opis skojarzony ze słowem kluczowym .PARAMETER, a komentarz instrukcji Param zostanie zignorowany.

.EXAMPLE

Przykładowe polecenie, które używa funkcji lub skryptu, opcjonalnie, a następnie przykładowe dane wyjściowe i opis. Powtórz to słowo kluczowe dla każdego przykładu.

.INPUTS

Typy obiektów programu Microsoft .NET Framework, które mogą być przesyłane potokami do funkcji lub skryptu. Można również dołączyć opis obiektów wejściowych.

.OUTPUTS

Typ programu .NET Framework obiektów zwracanych przez polecenie cmdlet. Można również dołączyć opis zwracanych obiektów.

.NOTES

Dodatkowe informacje na temat funkcji lub skryptu.

.LINK

Nazwa powiązanego tematu. Powtórz to słowo kluczowe dla każdego powiązanego tematu. Ta zawartość jest wyświetlana w sekcji Powiązane linki w temacie Pomoc.

Zawartość słowa kluczowego .LINK może również zawierać identyfikator URI (Uniform Resource Identifier) do wersji online tego samego tematu Pomocy. Wersja online zostanie otwarta po użyciu parametru OnlineGet-Help. Identyfikator URI musi zaczynać się od "http" lub "https".

.COMPONENT

Nazwa technologii lub funkcji używanej przez funkcję lub skrypt albo powiązane z nią funkcje. Parametr ComponentGet-Help używa tej wartości do filtrowania wyników wyszukiwania zwróconych przez Get-Help.

.ROLE

Nazwa roli użytkownika dla tematu pomocy. Parametr RoleGet-Help używa tej wartości do filtrowania wyników wyszukiwania zwróconych przez Get-Help.

.FUNCTIONALITY

Słowa kluczowe opisujące zamierzone użycie funkcji. Parametr FunctionalityGet-Help używa tej wartości do filtrowania wyników wyszukiwania zwróconych przez Get-Help.

.FORWARDHELPTARGETNAME <Command-Name>

Przekierowuje do tematu Pomocy dla określonego polecenia. Możesz przekierować użytkowników do dowolnego tematu Pomocy, w tym tematów Pomocy dotyczących funkcji, skryptu, polecenia cmdlet lub dostawcy.

.FORWARDHELPCATEGORY <Category>

Określa kategorię Pomoc elementu w .FORWARDHELPTARGETNAME. Użyj tego słowa kluczowego, aby uniknąć konfliktów, gdy istnieją polecenia o tej samej nazwie.

Prawidłowe wartości to:

• Pseudonim
• Polecenie cmdlet
• HelpFile
• Function
• Provider
• General
• FAQ
• Glossary
• ScriptCommand
• ExternalScript
• Filtr
• Cały

.REMOTEHELPRUNSPACE <PSSession-variable>

Określa sesję zawierającą temat Pomocy. Wprowadź zmienną zawierającą pssession. To słowo kluczowe jest używane przez polecenie cmdlet Export-PSSession, aby znaleźć tematy Pomocy dla wyeksportowanych poleceń.

.EXTERNALHELP <XML Help File>

Określa ścieżkę i/lub nazwę pliku pomocy opartej na formacie XML dla skryptu lub funkcji.

Słowo kluczowe .EXTERNALHELP informuje polecenie cmdlet Get-Help, aby uzyskać pomoc dotyczącą skryptu lub funkcji w pliku opartym na formacie XML. Słowo kluczowe .EXTERNALHELP jest wymagane w przypadku używania pliku pomocy opartej na formacie XML dla skryptu lub funkcji. Bez niego Get-Help nie znajdzie pliku pomocy dla funkcji lub skryptu.

Słowo kluczowe .EXTERNALHELP ma pierwszeństwo przed wszystkimi innymi słowami kluczowymi pomocy opartymi na komentarzach. Gdy .EXTERNALHELP jest obecny, polecenie cmdlet Get-Help nie wyświetla pomocy opartej na komentarzach, nawet jeśli nie może znaleźć pliku pomocy zgodnego z wartością słowa kluczowego.

Po wyeksportowaniu funkcji przez moduł skryptu wartość .EXTERNALHELP powinna być nazwą pliku bez ścieżki. Get-Help szuka pliku w podkatalogu specyficznym dla ustawień regionalnych katalogu modułu. Nie ma wymagań dotyczących nazwy pliku, ale najlepszym rozwiązaniem jest użycie następującego formatu nazwy pliku: <ScriptModule>.psm1-help.xml.

Jeśli funkcja nie jest skojarzona z modułem, dołącz ścieżkę i nazwę pliku do wartości słowa kluczowego .EXTERNALHELP. Jeśli określona ścieżka do pliku XML zawiera podkatalogi specyficzne dla kultury interfejsu użytkownika, Get-Help przeszukuje podkatalogi rekursywnie dla pliku XML o nazwie skryptu lub funkcji zgodnie ze standardami rezerwowymi języka ustanowionymi dla systemu Windows, podobnie jak w przypadku wszystkich tematów pomocy opartych na kodzie XML.

Aby uzyskać więcej informacji na temat formatu pliku Pomocy XML opartego na języku XML, zobacz Pisanie poleceń cmdlet programu Windows PowerShell — Pomoc.