Bemeneti típusok hozzáadása egy parancsmagokkal kapcsolatos súgótémakörhöz

Ez a szakasz azt ismerteti, hogyan adhat hozzá INPUTS szakaszt egy PowerShell-parancsmag súgótémaköréhez. Az INPUTS szakasz felsorolja az objektumok .NET-osztályát, amelyet a parancsmag bemenetként fogad el a folyamattól, érték vagy tulajdonságnév alapján.

Az INPUTS szakaszhoz hozzáadhat osztályok száma nincs korlátozva. A bemeneti típusok egy csomóponton vannak, az egyes osztályok pedig <command:inputTypes> egy <command:inputType> elemben.

A séma két <maml:description> elemet tartalmaz minden <command:inputType> elemben. A parancsmag azonban csak a elem tartalmát Get-Help jeleníti <command:inputType>/<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:inputTypes> csomópont.

<command:inputTypes>
  <command:inputType>
    <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:inputType>
</command:inputTypes>

Az alábbi XML egy példa arra, hogyan használható a <maml:inputTypes> csomópont egy bemeneti típus dokumentálásakor.

<command:inputTypes>
  <command:inputType>
    <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> You can pipe a date to the Set-Date cmdlet. <maml:para>
    <maml:description>
  </command:inputType>
</command:inputTypes>