Betiklere Yorum Tabanlı Yardım Yerleştirme

Bu konuda, Get-Help cmdlet'inin açıklama tabanlı yardım konusunu betikte olabilecek işlevlerle değil betiklerle ilişkilendirmesi için bir betik için açıklama tabanlı yardımın nereye yerleştirileceği açıklanmaktadır.

Betik için Comment-Based Yardımı Nereye Yerleştirileceği

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

  Betik Yardımı'nın önüne yalnızca açıklamalar ve boş satırlar eklenebilir.

• Betik dosyasının sonunda.

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

Betikte Yardım Yerleştirme Örnekleri

Aşağıdaki örneklerde, bir betik için açıklama tabanlı yardım için yerleştirme seçeneklerinin her biri gösterilmektedir.

Betiğin Başlangıcında Yardım

Aşağıdaki örnekte, bir betiğin başında açıklama tabanlı gösterilir.

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

param [string]$ComputerName
...

Betiğin Sonundaki Yardım

Aşağıdaki örnekte, bir betiğin sonunda açıklama tabanlı gösterilir.

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

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