PowerShell Çok Satırlı Yorum | PowerShell Çok Satırlı Yorum Kılavuzu

PowerShell Çok Satırlı Açıklamaya Giriş

PowerShell Çoklu satır yorumu, betiğin, fonksiyonun açıklamasını ekleme veya daha iyi anlamak için işlevselliği açıklayan yardım yazma ve betiğin veya betiğin bir kısmının o kısmı çalıştırmadan açıklanmasının yoludur ve ayrıca, Sözdizimini, parametreleri, örnekleri vb. ekleyerek fonksiyon hakkında yoruma dayalı yardım yazmak yararlı olacaktır.

Sözdizimi:

Çok satırlı yorumlar <#…#> bloğunun içinde açıklanmıştır.

Yoruma dayalı yardım.

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

Çok satırlı yorum PowerShell'de nasıl çalışır?

Tek satırlı yorumu eklemek için satırın önünde # karakterini kullanırız ve PowerShell 2.0 veya önceki sürümde bu, çok satırlı yorumları eklemenin tek yoluydu. Bu, 10 satırın açıklamasına sahipseniz satırın önüne 10 kez '#' koymanız gerektiği anlamına gelir.

Tek satırlık yorumlar '#', fonksiyonun veya betiğin küçük bir kısmını açıklamak için hala oradadır. Aşağıdaki tek satırlık yorumların nasıl göründüğüne bakın.

# This part won't be executed

Çıktı:

İfadeler veya herhangi bir sözdizimi bile bu bloğun içinde çalışmaz.

# Get-Date

Çıktı:

PowerShell, # anahtar kelimesini veya <#…#> anahtar kelimeler arasında herhangi bir içeriği bulduğunda, yürütme için o kısmı atlar.

Şimdi diyelim ki bir senaryomuz var ve onunla ilgili bir şeyler açıklamamız gerekiyor. Eğer tek satırlık yorumları kullanıyorsak, # satırdan her haberdar olduğunda yazmanın ne kadar saçma göründüğünü düşünebilir misiniz?

Bu şekilde, komut dosyasındaki çok satırlı yorumları <#…#> ekleyerek her satırın karşısına # işaretini koymamız gerekir, #<'den kaçınabiliriz her zaman imzala.

Dikkat edilmesi gereken birkaç nokta:

  • Bloğun içine girilen yorumların yazı tiplerini biçimlendiremezsiniz. Yazı tiplerini kalın yapmayı deneyin, yazı tipinin rengini değiştirin, işe yaramayacaktır çünkü bu her düzenleyici için benzersiz bir formattır. Yorum bloğunun renkli görüntüsü, kullandığımız düzenleyiciye ve seçtiğiniz temaya bağlıdır.

Çok satırlı veya tek satırlı yorumlar PowerShell ISE ve Visual Studio kodunda farklı görünebilir. Aşağıda PowerShell ISE ve VS kodundan çok satırlı yorumlar bulunmaktadır.

<# Bu yorum PowerShell ISE'dendir

Yazı tipi rengi VS kodundan farklı

#>

Atom temalı VS kodundan.

<# This comment is from the VS code
Font color is different than PowerShell ISE
#>
  • Çok satırlı yorum bloğunun içine herhangi bir değişken değeri iletemezsiniz. Örneğin,
$name = "PowerShell"
<#
This $name variable won't expand because
This is a multiline comment
#&gt

Çıktı adı genişletemez.

Örnekler

PowerShell MultiLine Comment örneklerini tartışalım.

Örnek 1: Komut dosyasını açıklamak için çok satırlı bir yorum ekleme

Bir script yazdığınızda, scriptin versiyon, işlevsellik gibi bilgilerini aşağıda gösterildiği gibi çok satırlı yorumlarla tanımlayabilir ve herhangi bir sınırlama olmadığı için istediğiniz kadar kullanabilirsiniz.

İşte tek ve çok satırlı yorumların bir kombinasyonu.

<#
Script Version: 1.0
Script Author: Chirag Nagrekar
Repo Location: Company Git Location
#>
function StopServices{
<#
Using foreach loop for the script
Getting the name of the servers to stop the Spooler service
#>
foreach($server in $servers){
Stop-Service -Name Spooler -Force -Verbose
}
}
#Calling StopServices Function
StopServices

Örnek #2: Çok satırlı yorumlar eklemenin kısayolu

Visual studio kodunda yorum yapmamız gereken satırları seçip ardından ALT + SHIFT + A tuşlarına basarak çok satırlı yorumları ekleme kısayolu bulunmaktadır.

Örneğin,

This is the first line
This is the second line
This is the third line

Yukarıdaki satırlara yorum yapmamız gerekiyor. Öncelikle bu satırları seçin ve ALT + SHIFT + A tuşlarına basın.

Çıktı:

Örnek 3: Yardım açıklamasına çok satırlı yorumlar ekleme

Çok satırlı yorumlar, aşağıda gösterildiği gibi yoruma dayalı yardım yazmak için de faydalıdır. Bunlar spesifiktir ve .HelpName ile açıklanmıştır.

function CheckConnectivity{
param(
[String]$computername,
[String]$Timeout
)
<#
.SYNOPSIS
This function retries the computer connectivity for the specific time.
.PARAMETER ComputerName
Remote Computer Name
.PARAMETER Timeout
Specify the timeout in seconds
.EXAMPLE
PS> CheckConnectitivy -ComputerName TestComp -Timeout 120
#>
}

Bu işlevle ilgili yardımı kontrol ettiğinizde, yukarıdaki yoruma dayalı yardım, işlevi açıklamak için faydalıdır.

Bu bölüm hakkında daha fazla bilgi edinmek için aşağıdaki bağlantıyı kullanın.

microsoft.powershell.core

Çözüm

Yalnızca PowerShell değil, hemen hemen tüm diğer üst düzey programlama dilleri de tek ve çok satırlı yorumlar kullanır; böylece bir komut dosyası yazdığımızda, her şeyi çıktı konsoluna yazdırmamıza gerek kalmaz, ancak kullanıcıların veya komut dosyalarının belirli komut dosyasının ne olduğunu anlaması gerekir. Bunun için script versiyonundan bahsedebilirsiniz. Ayrıca komut dosyasıyla ilgili yardım da ekleyebilirsiniz.

İlgili makaleler