Jak dodać przykłady do tematu pomocy dotyczącego polecenia cmdlet

  • Artykuł

Co należy wiedzieć o przykładach w pomocy dotyczącej polecenia cmdlet

  • Lista wszystkich nazw parametrów w poleceniu, nawet jeśli nazwy parametrów są opcjonalne. Ułatwia to użytkownikowi interpretowanie polecenia.

  • Unikaj aliasów i częściowych nazw parametrów, nawet jeśli działają w programie PowerShell.

  • W opisie przykładu wyjaśnij uzasadnienie konstrukcji polecenia. Wyjaśnij, dlaczego wybrano konkretne parametry i wartości oraz jak używać zmiennych.

  • Jeśli polecenie używa wyrażeń, wyjaśnij je szczegółowo.

  • Jeśli polecenie używa właściwości i metod obiektów, szczególnie właściwości, które nie są wyświetlane na ekranie domyślnym, użyj przykładu jako szansy sprzedaży poinformuj użytkownika o obiekcie.

Widoki Pomocy, które wyświetlają przykłady

Przykłady są wyświetlane tylko w szczegółowych i pełnych widokach pomocy polecenia cmdlet.

Dodawanie przykładowego węzła

Poniższy kod XML pokazuje, jak dodać węzeł Przykłady zawierający jeden przykładowy węzeł. Dodaj dodatkowe przykładowe węzły dla każdego przykładu, który chcesz uwzględnić w temacie.

<command:examples>
  <command:example>
  </command:example>
</command:examples>

Dodawanie przykładowego tytułu

Poniższy kod XML pokazuje, jak dodać tytuł przykładu. Tytuł służy do odróżniania przykładu od innych przykładów. Program PowerShell używa standardowego nagłówka, który zawiera sekwencyjny przykładowy numer.

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
  </command:example>
</command:examples>

Dodawanie poprzednich znaków

Poniższy kod XML pokazuje, jak dodać znaki, takie jak Windows PowerShell wiersza polecenia, które są wyświetlane bezpośrednio przed przykładowe polecenie (bez żadnych spacji). Program PowerShell używa Windows PowerShell wiersza polecenia: C:\PS> .

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:Introduction>
      <maml:paragraph>C:\PS></maml:paragraph>
    </maml:Introduction>
</command:example>
</command:examples>

Dodawanie polecenia

Poniższy kod XML pokazuje, jak dodać rzeczywiste polecenie w przykładzie. Podczas dodawania polecenia wpisz całą nazwę (nie używaj aliasu) poleceń cmdlet i parametrów. Jeśli to możliwe, używaj małych liter.

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:Introduction>
      <maml:paragraph>C:\PS></maml:paragraph>
    </maml:Introduction>
    <dev:code> command </dev:code>
</command:example>
</command:examples>

Dodawanie opisu

Poniższy kod XML pokazuje, jak dodać opis przykładu. Program PowerShell używa jednego zestawu <maml:para> tagów dla opisu, mimo że można <maml:para> użyć wielu tagów.

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:Introduction>
      <maml:paragraph>C:\PS></maml:paragraph>
    </maml:Introduction>
    <dev:code> command </dev:code>
    <dev:remarks>
      <maml:para> command description </maml:para>
    </dev:remarks>
</command:example>
</command:examples>

Dodawanie przykładowych danych wyjściowych

Poniższy kod XML pokazuje, jak dodać dane wyjściowe polecenia. Informacje o wynikach polecenia są opcjonalne, ale w niektórych przypadkach warto zademonstrować efekt użycia określonych parametrów. Program PowerShell używa dwóch zestawów pustych <maml:para> tagów, aby oddzielić dane wyjściowe polecenia od polecenia .

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:Introduction>
      <maml:paragraph>C:\PS></maml:paragraph>
    </maml:Introduction>
    <dev:code> command </dev:code>
    <dev:remarks>
      <maml:para> command description </maml:para>
      <maml:para></maml:para>
      <maml:para></maml:para>
      <maml:para> command output </maml:para>
</dev:remarks>
</command:example>
</command:examples>