Yorum Tabanlı Yardımın Sözdizimi

Bu bölümde yoruma dayalı yardımın sözdizimi açıklanmaktadır.

Sözdizimi Şeması

Yoruma dayalı Yardımın sözdizimi aşağıdaki gibidir:

# .< help keyword>
# <help content>

-veya -

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

Sözdizimi Açıklama

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

Yoruma dayalı Yardım'ın her bölümü bir anahtar sözcükle tanımlanır ve her anahtar sözcüğün önüne bir nokta (.) gelir. Anahtar kelimeler herhangi bir sırada görünebilir. Anahtar kelime adları büyük/küçük harfe duyarlı değildir.

Bir yorum bloğu en az bir yardım anahtar sözcüğü içermelidir. EXAMPLE gibi bazı anahtar kelimeler aynı yorum bloğunda birçok kez görünebilir. Her anahtar kelimenin Yardım içeriği, anahtar kelimeden sonraki satırda başlar ve birden fazla satıra yayılabilir.

Yoruma dayalı bir Yardım konusundaki tüm satırlar bitişik olmalıdır. Yorum tabanlı bir Yardım konusu, Yardım konusunun parçası olmayan bir yorumun ardından geliyorsa, Yardım dışı son yorum satırı ile yorum tabanlı Yardımın başlangıcı arasında en az bir boş satır olmalıdır.

Örneğin, aşağıdaki yoruma dayalı yardım konusu, .Description anahtar sözcüğünü ve bir işlevin veya komut dosyasının açıklaması olan değerini içerir.

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