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 platformy .NET, które mogą być przesyłane potokami do funkcji lub skryptu. Można również dołączyć opis obiektów wejściowych. Powtórz to słowo kluczowe dla każdego typu danych wejściowych.

.OUTPUTS

Typ obiektów .NET zwracanych przez polecenie cmdlet. Można również dołączyć opis zwracanych obiektów. Powtórz to słowo kluczowe dla każdego typu danych wyjściowych.

.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) prowadzący do wersji tego samego tematu pomocy dostępnej online. Wersja online otwiera się po użyciu parametru Online w Get-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 zawartości pomocy dotyczącej funkcji, skryptu, cmdlet lub dostawcy.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

Określa kategorię pomocy elementu w .FORWARDHELPTARGETNAME. Prawidłowe wartości to Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filterlub All. Użyj tego słowa kluczowego, aby uniknąć konfliktów, gdy istnieją polecenia o tej samej nazwie.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

Określa sesję zawierającą temat pomocy. Wprowadź zmienną zawierającą obiekt PSSession. To słowo kluczowe jest używane przez polecenie cmdlet [Export-PSSession][09] w celu znalezienia zawartości pomocy dla wyeksportowanych poleceń.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Określa plik pomocy opartej na formacie XML dla skryptu lub funkcji.

# .EXTERNALHELP <XML Help File>

Słowo kluczowe .EXTERNALHELP jest wymagane, gdy funkcja lub skrypt są udokumentowane w plikach XML. Bez tego słowa kluczowego Get-Help nie może znaleźć pliku pomocy opartej na formacie XML dla funkcji lub skryptu.

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

Jeśli funkcja jest eksportowana przez moduł, ustaw wartość słowa kluczowego .EXTERNALHELP na nazwę pliku bez ścieżki. Get-Help wyszukuje określoną nazwę pliku w podkatalogu specyficznym dla języka katalogu modułu. Nie ma wymagań dotyczących nazwy pliku pomocy opartej na formacie XML dla funkcji. Począwszy od programu PowerShell 5.0, funkcje wyeksportowane przez moduł można udokumentować w pliku pomocy o nazwie dla modułu. Nie musisz używać .EXTERNALHELP słowa kluczowego komentarza. Jeśli na przykład Test-Function funkcja zostanie wyeksportowana przez MyModule moduł, możesz nazwać plik MyModule-help.xmlpomocy . Polecenie Get-Help cmdlet szuka pomocy dla Test-Function funkcji w MyModule-help.xml pliku w katalogu modułu.

Jeśli funkcja nie jest uwzględniona w module, dołącz ścieżkę do pliku pomocy opartej na formacie XML. Jeśli wartość zawiera ścieżkę, a ścieżka 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 katalogu modułu.

Aby uzyskać więcej informacji na temat formatu pliku pomocy opartej na xml polecenia cmdlet, zobacz How to Write Cmdlet Help.