Jak dodać wartości zwracane do tematu pomocy dotyczącego polecenia cmdlet
W tej sekcji opisano sposób dodawania sekcji DANE WYJŚCIOWE do tematu pomocy dotyczącej poleceń cmdlet programu PowerShell. Sekcja OUTPUTS zawiera listę klas .NET obiektów, które polecenie cmdlet zwraca lub przekazuje w dół potoku.
Nie ma żadnego ograniczenia liczby klas, które można dodać do sekcji DANE WYJŚCIOWE. Zwracane typy polecenia cmdlet są ujęte w węzeł, a każda <command:returnValues>
klasa jest ujęta w <command:returnValue>
element .
Jeśli polecenie cmdlet nie generuje żadnych danych wyjściowych, użyj tej sekcji, aby wskazać, że nie ma żadnych danych wyjściowych. Na przykład w miejsce nazwy klasy wpisz Brak i podaj krótkie wyjaśnienie. Jeśli polecenie cmdlet generuje dane wyjściowe warunkowo, użyj tego węzła, aby wyjaśnić warunki i opisać warunkowe dane wyjściowe.
Schemat zawiera dwa elementy <maml:description>
w każdym <command:returnValue>
elemencie.
Jednak polecenie Get-Help
cmdlet wyświetla tylko zawartość <command:returnValue>/<maml:description>
elementu.
Począwszy od programu PowerShell 3.0, Get-Help
polecenie cmdlet wyświetla zawartość <maml:uri>
elementu.
Ten element umożliwia kierowanie użytkowników do tematów opisujących klasę .NET.
Poniższy kod XML przedstawia <maml:returnValues>
węzeł.
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name> Class Name </maml:name>
<maml:uri> URI of a topic that describes the class </maml:uri>
<maml:description/>
</dev:type>
<maml:description>
<maml:para> Brief description <maml:para>
</maml:description>
</command: returnValue>
</command: returnValues>
Poniższy kod XML przedstawia przykład użycia węzła <maml:returnValues>
do udokumentowania typu danych wyjściowych.
<command:returnValues>
<command:returnValue>
<dev:type>
<maml:name> System.DateTime </maml:name>
<maml:uri> https://docs.microsoft.com/dotnet/api/system.datetime </maml:uri>
<maml:description/>
</dev:type>
<maml:description>
<maml:para> Get-Date returns a DateTime object. <maml:para>
</maml:description>
</command: returnValue>
</command: returnValues>
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla