Yorum Tabanlı Yardım Söz Dizimi

Bu bölümde açıklama tabanlı yardımın söz dizimi açıklanmaktadır.

Söz Dizimi Diyagramı

Açıklama tabanlı Yardım'ın söz dizimi aşağıdaki gibidir:

# .< help keyword>
# <help content>

-veya-

<#
.< help keyword>
< help content>
#>

Söz Dizimi Açıklaması

Açıklama tabanlı Yardım, bir açıklama dizisi olarak yazılır. Her açıklama satırından önce bir açıklama simgesi (#) yazabilir veya açıklama bloğu oluşturmak için <# ve #> simgelerini kullanabilirsiniz. Açıklama bloğundaki tüm satırlar açıklama olarak yorumlanır.

Açıklama tabanlı Yardım'ın her bölümü bir anahtar sözcükle tanımlanır ve her anahtar sözcüğün önünde nokta (.) yer alır. Anahtar sözcükler herhangi bir sırada görünebilir. Anahtar kelime adları büyük/küçük harfe duyarlı değildir.

Açıklama bloğu en az bir yardım anahtar sözcüğü içermelidir. .EXAMPLEgibi bazı anahtar sözcükler aynı açıklama bloğunda birçok kez görünebilir. Her anahtar sözcüğün Yardım içeriği, anahtar sözcüğün ardından satırda başlar ve birden çok satıra yayılabilir.

Açıklama tabanlı Yardım konu başlığındaki tüm satırlar bitişik olmalıdır. Açıklama tabanlı Yardım konusu, Yardım konusunun parçası olmayan bir açıklamayı izlerse, Yardım dışı son açıklama satırı ile açıklama tabanlı Yardım'ın başlangıcı arasında en az bir boş satır olmalıdır.

Örneğin, aşağıdaki açıklama tabanlı yardım konusu .DESCRIPTION anahtar sözcüğünü ve bir işlevin veya betiğin açıklaması olan değerini içerir.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>