Komut Dosyalarına Yorum Tabanlı Yardım Yerleştirme

Bu konu, Get-Help cmdlet'inin yorum tabanlı yardım konusunu komut dosyasında olabilecek herhangi bir işlevle değil komut dosyalarıyla ilişkilendirmesi için bir komut dosyası için yorum tabanlı yardımın nereye yerleştirileceğini açıklar.

Bir Komut Dosyası için Yorum Tabanlı Yardımın Nereye Yerleştirileceği

  • Komut dosyasının başında.

    Komut Dosyası Yardımından önce komut dosyasında yalnızca yorumlar ve boş satırlar gelebilir.

  • Komut dosyasının sonunda.

    Betik gövdesindeki ilk öğe (Yardım'dan sonra) bir işlev bildirimiyse, Yardım betiğinin sonu ile işlev bildirimi arasında en az iki boş satır olmalıdır. Aksi takdirde Yardım, komut dosyası için değil, işlev için Yardım olarak yorumlanır.

Komut Dosyasına Yardım Yerleştirme Örnekleri

Aşağıdaki örnekler, bir komut dosyası için yoruma dayalı yardıma yönelik yerleştirme seçeneklerinin her birini göstermektedir.

Bir Komut Dosyasının Başlangıcında Yardım

Aşağıdaki örnek, bir betiğin başlangıcındaki yoruma dayalı durumu gösterir.

<#
.Description
This script performs a series of network connection tests.
#>

param [string]$ComputerName
...

Komut Dosyasının Sonunda Yardım

Aşağıdaki örnek, bir betiğin sonunda yoruma dayalı olarak gösterilmektedir.

...
function Ping { Test-Connection -ComputerName $ComputerName }

<#
.Description
This script performs a series of network connection tests.
#>

İlgili makaleler