Bir cmdlet yardım konusuna giriş türleri nasıl eklenir?

Not

XML tabanlı yardımın manuel olarak yazılması çok zordur. PlatyPS modülü, Markdown'da yardım yazmanıza ve ardından bunu XML tabanlı yardıma dönüştürmenize olanak tanır. Bu, yardım yazmayı ve sürdürmeyi çok daha kolaylaştırır. PlatyPS ayrıca sizin için Güncellenebilir Yardım paketleri de oluşturabilir. Daha fazla bilgi için PlatyPS kullanarak XML tabanlı yardım oluşturma konusuna bakın.

Bu bölümde PowerShell cmdlet Yardım konusuna GİRİŞLER bölümünün nasıl ekleneceği açıklanmaktadır. GİRİŞLER bölümü, cmdlet'in ardışık düzenden giriş olarak kabul ettiği nesnelerin .NET sınıflarını değere veya özellik adına göre listeler.

GİRİŞLER bölümüne ekleyebileceğiniz sınıf sayısında herhangi bir sınırlama yoktur. Giriş türleri bir <command:inputTypes> düğümünün içine alınır ve her sınıf bir <command:inputType> öğesinin içine alınır.

Şema, her <command:inputType> öğesinde iki <maml:description> öğesi içerir. Ancak Get-Help cmdlet'i yalnızca <command:inputType>/ öğesinin içeriğini görüntüler.

PowerShell 3.0'dan itibaren Get-Help cmdlet'i <maml:uri> öğesinin içeriğini görüntüler. Bu öğe, kullanıcıları .NET sınıfını açıklayan konulara yönlendirmenizi sağlar.

Aşağıdaki XML <maml:inputTypes> düğümünü gösterir.

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

Aşağıdaki XML, bir giriş türünü belgelemek için <maml:inputTypes> düğümünü kullanmanın bir örneğini gösterir.

<command:inputTypes>
  <command:inputType>
    <dev:type>
      <maml:name>System.DateTime</maml:name>
      <maml:uri>https://learn.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>

İlgili makaleler