Lägga till returvärden i ett cmdlet-hjälpavsnitt

I det här avsnittet beskrivs hur du lägger till ett OUTPUTS-avsnitt i ett PowerShell-cmdlet-hjälpavsnitt. I avsnittet OUTPUTS visas de .NET-klasser med objekt som cmdleten returnerar eller skickar nedåt i pipelinen.

Det finns ingen gräns för antalet klasser som du kan lägga till i avsnittet OUTPUTS. Returtyperna för en cmdlet omges av en <command:returnValues> nod, där varje klass omges av ett <command:returnValue> element.

Om en cmdlet inte genererar några utdata använder du det här avsnittet för att ange att det inte finns några utdata. I stället för klassnamnet skriver du till exempel Ingen och ger en kort förklaring. Om cmdleten genererar utdata villkorligt använder du den här noden för att förklara villkoren och beskriva villkorliga utdata.

Schemat innehåller två <maml:description> element i varje <command:returnValue> element. Get-HelpCmdleten visar dock bara innehållet i <command:returnValue>/<maml:description> elementet .

Från och med PowerShell 3.0 Get-Help visar cmdleten innehållet i <maml:uri> elementet . Med det här elementet kan du dirigera användare till ämnen som beskriver .NET-klassen.

Följande XML visar <maml:returnValues> noden.

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

Följande XML visar ett exempel på hur du använder <maml:returnValues> noden för att dokumentera en utdatatyp.

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