Lägga till indatatyper i ett cmdlet-hjälpavsnitt
I det här avsnittet beskrivs hur du lägger till ett INPUTS-avsnitt i ett PowerShell-cmdlet-hjälpavsnitt. Avsnittet INPUTS visar de .NET-klasser med objekt som cmdleten accepterar som indata från pipelinen, antingen efter värde eller egenskapsnamn.
Det finns ingen gräns för antalet klasser som du kan lägga till i ett INPUTS-avsnitt. Indatatyperna omges av en <command:inputTypes>
nod, där varje klass omges av ett <command:inputType>
element.
Schemat innehåller två <maml:description>
element i varje <command:inputType>
element.
Get-Help
Cmdleten visar dock bara innehållet i <command:inputType>/<maml:description>
elementet .
Från och med PowerShell 3.0 visar Get-Help
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:inputTypes>
noden.
<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>
Följande XML visar ett exempel på hur du använder <maml:inputTypes>
noden för att dokumentera en indatatyp.
<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>
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i:Skicka och visa feedback för