Cmdlet Yardım Konusuna Örnekler Ekleme

  • Makale

Cmdlet Yardım'da Örnekler hakkında Bilgi

  • Parametre adları isteğe bağlı olsa bile komutta tüm parametre adlarını listele. Bu, kullanıcının komutu kolayca yorumlaması için yardımcı olur.

  • PowerShell'de çalışmalarına rağmen diğer adlardan ve kısmi parametre adlarından kaçının.

  • Örnek açıklamasında, komutun yapısına ilişkin rasyonalizi açıklayacak. Belirli parametreleri ve değerleri neden seçtiğinizi ve değişkenleri nasıl kullanabileceğini açıklayacaksınız.

  • Komut ifadeleri kullanıyorsa bunları ayrıntılı olarak açıklayacak.

  • Komut, özellikle de varsayılan görüntüde görünmeen nesnelerin özelliklerini ve yöntemlerini kullanıyorsa, kullanıcıya nesnesi hakkında bilgi vermek için örneği bir fırsat olarak kullanın.

Örnekleri Görüntüleyen Yardım Görünümleri

Örnekler yalnızca Cmdlet Yardımı'nın Ayrıntılı ve Tam görünümlerinde görünür.

Örnek Düğüm Ekleme

Aşağıdaki XML, tek bir Örnek düğüm içeren Bir Örnekler düğümünün nasıl ekli olduğunu gösterir. Konuya eklemek istediğiniz her örnek için ek örnek düğümler ekleyin.

<command:examples>
  <command:example>
  </command:example>
</command:examples>

Örnek Başlık Ekleme

Aşağıdaki XML, örnek için bir başlık eklemeyi gösterir. Başlık, örneği diğer örnekler dışında ayarlamak için kullanılır. PowerShell sıralı örnek sayı içeren standart bir üst bilgi kullanır.

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
  </command:example>
</command:examples>

Önceki Karakterleri Ekleme

Aşağıdaki XML, örnek komutun hemen önünde görüntülenen Windows PowerShell (müdahale eden boşluk olmadan) gibi karakterlerin nasıl eklendiğinde gösterilir. PowerShell şu Windows PowerShell kullanır: C:\PS> .

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:Introduction>
      <maml:paragraph>C:\PS></maml:paragraph>
    </maml:Introduction>
</command:example>
</command:examples>

Komutu Ekleme

Aşağıdaki XML, örneğin gerçek komutunun nasıl ekli olduğunu gösterir. Komutu eklerken, cmdlet'ler ve parametrelerin tam adını (diğer adı kullanma) yazın. Ayrıca mümkün olduğunca küçük harf karakterler kullanın.

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:Introduction>
      <maml:paragraph>C:\PS></maml:paragraph>
    </maml:Introduction>
    <dev:code> command </dev:code>
</command:example>
</command:examples>

Açıklama Ekleme

Aşağıdaki XML, örnek için açıklama eklemeyi gösterir. PowerShell, açıklama için tek bir etiket kümesi <maml:para> kullanır ancak birden çok etiket <maml:para> kullanılabilir.

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:Introduction>
      <maml:paragraph>C:\PS></maml:paragraph>
    </maml:Introduction>
    <dev:code> command </dev:code>
    <dev:remarks>
      <maml:para> command description </maml:para>
    </dev:remarks>
</command:example>
</command:examples>

Örnek Çıkış Ekleme

Aşağıdaki XML, komutun çıktısını nasıl ekley olduğunu gösterir. Komut sonuçları bilgileri isteğe bağlıdır, ancak bazı durumlarda belirli parametreleri kullanmanın etkisini göstermek yararlı olur. PowerShell, komut çıktısını <maml:para> komuttan ayırmak için iki boş etiket kümesi kullanır.

<command:examples>
  <command:example>
    <maml:title>----------  EXAMPLE 1  ----------</maml:title>
    <maml:Introduction>
      <maml:paragraph>C:\PS></maml:paragraph>
    </maml:Introduction>
    <dev:code> command </dev:code>
    <dev:remarks>
      <maml:para> command description </maml:para>
      <maml:para></maml:para>
      <maml:para></maml:para>
      <maml:para> command output </maml:para>
</dev:remarks>
</command:example>
</command:examples>