Visszatérési értékek hozzáadása egy parancsmagokkal kapcsolatos súgótémakörhöz

Ez a szakasz azt ismerteti, hogyan adhat hozzá OUTPUTS szakaszt egy PowerShell-parancsmagokkal kapcsolatos súgótémakörben. Az OUTPUTS szakasz a parancsmag által visszaadott vagy továbbküldett objektumok .NET-osztályát sorolja fel.

Az OUTPUTS (KIMENETEK) szakaszhoz hozzáadhat osztályok száma nincs korlátozva. A parancsmagok visszatérési típusai egy csomóponton vannak, az egyes osztályok pedig <command:returnValues> egy elemben <command:returnValue> vannak.

Ha egy parancsmag nem hoz létre kimenetet, ebben a szakaszban jelezheti, hogy nincs kimenet. Az osztálynév helyére írja például a Nincs nevet, és adjon meg egy rövid magyarázatot. Ha a parancsmag feltételesen hoz létre kimenetet, ezzel a csomóponttal ismertetheti a feltételeket, és leírhatja a feltételes kimenetet.

A séma két <maml:description> elemet tartalmaz minden <command:returnValue> elemben. A parancsmag azonban csak a elem tartalmát Get-Help jeleníti <command:returnValue>/<maml:description> meg.

A PowerShell 3.0-ástól kezdve a parancsmag megjeleníti Get-Help a elem <maml:uri> tartalmát. Ezzel az elemmel a felhasználókat a .NET-osztályt leíró témakörökbe irányíthatja.

Az alábbi XML-fájlban látható a <maml:returnValues> csomópont.

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

Az alábbi XML-fájl egy példát mutat be arra, hogyan használható <maml:returnValues> a csomópont egy kimeneti típus dokumentálása érdekében.

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