Jak přidat příklady do tématu nápovědy rutiny

Článek
09/25/2021

Věci týkající se příkladů v nápovědě k rutinám

Vypíše všechny názvy parametrů v příkazu, a to i v případě, že jsou názvy parametrů nepovinné. To pomáhá uživateli snadno interpretovat příkaz.
Nepoužívejte aliasy a názvy částečných parametrů, i když pracují v prostředí PowerShell.
V příkladu popisu Vysvětlete racionální konstrukce příkazu. Vysvětlete, proč jste zvolili konkrétní parametry a hodnoty a jak používáte proměnné.
Pokud příkaz používá výrazy, vysvětlete je podrobněji.
Pokud příkaz používá vlastnosti a metody objektů, zejména vlastnosti, které se nezobrazují ve výchozím zobrazení, použijte příklad jako příležitost k oznámení uživatele o objektu.

Zobrazení příkladů s příklady

Příklady se zobrazí pouze v podrobných a úplných zobrazeních v nápovědě k rutinám.

Přidání uzlu příklady

Následující kód XML ukazuje, jak přidat uzel Příklady , který obsahuje jeden vzorový uzel. Přidejte další příklady uzlů pro každý z příkladů, které chcete zahrnout do tématu.

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

Přidání příkladu nadpisu

Následující kód XML ukazuje, jak přidat název pro příklad. Název slouží k nastavení příkladu od jiných příkladů. Prostředí PowerShell používá standardní hlavičku, která obsahuje pořadové číslo s pořadovým číslem.

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

Přidávání předchozích znaků

následující kód XML ukazuje, jak přidat znaky, například Windows PowerShell výzvy, které jsou zobrazeny těsně před ukázkovým příkazem (bez mezer). prostředí PowerShell používá Windows PowerShell výzvy: 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>

Přidání příkazu

Následující kód XML ukazuje, jak přidat vlastní příkaz v příkladu. Při přidávání příkazu zadejte celý název (Nepoužívejte alias) rutin a parametrů. Pokud je to možné, používejte i malými písmeny.

<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>

Přidání popisu

Následující kód XML ukazuje, jak přidat popis pro příklad. Prostředí PowerShell používá <maml:para> pro popis jednu sadu značek, a to i v případě, že <maml:para> lze použít více značek.

<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>

Přidání příkladu výstupu

Následující kód XML ukazuje, jak přidat výstup příkazu. Informace o výsledcích příkazu jsou volitelné, ale v některých případech je užitečné Ukázat účinek použití určitých parametrů. <maml:para>K oddělení výstupu příkazu z příkazu používá PowerShell dvě sady prázdných značek.

<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>