PowerShell yorumu | PowerShell yorumuna Hızlı Bakış

PowerShell yorumuna giriş

PowerShell yorumu, kodun temel kısa ayrıntılarını vermeye yönelik bir tür yardımdır. PowerShell betiğinin herhangi bir bölümüne, işlev için sağlayabileceğiniz bir yorum veya koşullar, döngüler vb. için sağlayabileceğiniz bir yorum gibi bir yorum ekleyebilirsiniz. Kodu okuyan scripter, kodun ne hakkında olduğunu kolayca anlayacaktır. . Yardım bölümlerini sağlamak için yorumları da kullanabiliriz. Betik yürütüldüğünde yorum görüntülenmez; sadece kullanıcı bilgisi içindir.

PowerShell yorumu türleri

Kullanabileceğimiz iki tür PowerShell yorumu vardır:

  • Tek Satırlı Yorum: Buna aynı zamanda Satır İçi yorum da denir ve yalnızca bir satıra yorum yapılabilir.
  • Çok Satırlı Yorum: Buna blok yorumu da denir ve kodun birkaç satırına veya kodun tamamına uygulanır.

Sözdizimi:

Tek satırlı yorum veya Satır içi yorum, Hash (#) sözdizimi ile açıklanabilirken, çok satırlı yorumlar veya blok yorumlar, <#..#> gibi etiketler ve Hash ile açıklanabilir.

Örnekler

Aşağıda PowerShell yorumunun örnekleri verilmiştir:

Örnek #1

Kodu açıklamak için tek satırlı yorum.

Kod:

Rename-Item C:\Temp\azgroup.json -NewName azuregroup.json  # This command will rename the item

Örnek #2

İşlevi açıklayan Tek Yorum.

Kod:

function GetData{
#Function will get the data from azure blob
}

Örnek #3

Belirli bir kodu devre dışı bırakmak için yorum yapın.

Kod:

# Copy-Item C:\Temp\NewUsers.csv -Destination \\test1-win2k12\c$\temp

Herhangi bir koda yorum yaptığınızda satırın renginin değiştiğini fark edebilirsiniz. Bu, editöre ve o editör için uyguladığınız temaya bağlıdır. "Döngü", "" fonksiyon, "" for döngü "vb. gibi birden çok satırı bir arada açıklayan bloğunuz varsa ve tek bir satıra yorum uygularsanız bu bir hata oluşturabilir.

Kod:

while($i -gt 10){
Write-Output $i
$i++
}

Yukarıdaki örnekte bir yorumu kullanarak ilk satırı devre dışı bırakırsanız bir hata oluşacaktır.

Kod:

# while($i -gt 10){
Write-Output $i
$i++
}

Çıktı:

Hata, '{' işaretini zaten devre dışı bıraktığımız için ek '}' beklenmediğini söylüyor. Birden fazla kod satırını devre dışı bırakmak için tek satırlı yorumu kullanabilirsiniz.

Kod:

# while($i -gt 10){
#  Write-Output $i
#  $i++
#}

Ancak bu yöntem önerilmez; bunun yerine, bunları devre dışı bırakmak için çok satırlı yorumu kullanabiliriz ve bu, sonraki örneklerde gösterilmektedir.

Örnek #4

Komut dosyasını tanımlamak için Çok Satırlı yorum.

Kod:

<#
This program is to test the server connectivity.
Once connectivity establishes it checks the WINRM connection on the server.
The third step is to push the Application agent on the servers
In the final step, server will be rebooted
#>

Yukarıdaki örnekte PowerShell kullanarak çok satırlı bir yorum bloğu oluşturduk ve bu blok çalıştırılmayacak. Tarih biçimi gibi parametrelerle ilgili belirli ayrıntıları koymak istediğinizde veya günlüklerin çıkış yolu gibi kullanıcının betiği çalıştırmadan önce not etmesi gereken durumlarda kullanılır.

Örnek #5

İşlevi veya kodun bir kısmını devre dışı bırakmak için çok satırlı yorum.

'c' örneğinde gösterildiği gibi, tek satırlık yorumları kullanarak while döngüsünün tamamını devre dışı bırakabiliriz, ancak çok satırlı yorumları kullanmak çok daha kolay olacaktır.

Kod:

<#while($i -gt 10){
Write-Output $i
$i++
}#>

Tek satırlık yorumdan çok daha kolaydır.

PowerShell yorumlarına Dayalı Yardım

Bu aynı zamanda çok satırlı bir yorum türüdür. PowerShell yorumlarına dayalı, Anahtar Kelimeler üzerinde çalışmaya yardımcı olur. Her Anahtar Kelime, kullanım amacına yönelik belirli konuları açıklar ve çok satırlı yorum bölümünde kullanılabilir.

Bu anahtar sözcükler herhangi bir sırada görünebilir, büyük/küçük harfe duyarlı değildir ve nokta (.) ile başlarlar. Tüm anahtar kelimelerden bahsetmek gerekli değildir. İhtiyacınıza göre bunlardan birkaçını ekleyebilirsiniz.

  • .ÖZET: İşlevin veya komut dosyasının kısa bir açıklaması. Bu anahtar kelime yalnızca bir kez kullanılır.
  • .AÇIKLAMA: Komut dosyasının ayrıntılı açıklaması. Bu anahtar kelime yalnızca bir kez kullanılır.
  • .ÖRNEK: Komut dosyası için giriş ve çıkışla birlikte örnek bir örnek. Birden fazla örnek ekleyebiliriz.
  • .PARAMETER : Parametrenin açıklaması. Bu anahtar kelime koddaki her parametre için kullanılabilir. Herhangi bir sırada olabilir ancak Param() bloğunda bahsedildikleri sıra yardım bölümünde görünecektir.
  • .INPUTS: Komut dosyasına veya işleve yönlendirilebilecek giriş nesnelerinin veya nesne türlerinin açıklaması.
  • .OUTPUTS: Döndürülen nesnenin açıklaması veya cmdlet'in döndürdüğü nesnelerin türleri.

Yukarıdakiler genel olarak fonksiyonun yoruma dayalı yardım bölümünü anlatmak için ihtiyaç duyduğumuz temel anahtar kelimelerdir. Bunun dışında NOTLAR, BAĞLANTI, BİLEŞEN, ROL, İŞLEVSELLİK vb. gibi belirtebileceğiniz başka anahtar kelimeler de vardır.

Örnek:

Kod:

function TestRemotePort{
param(
[String]$ComputerName,
[Int]$Port
)
<#
.SYNOPSIS
Function to test remote ports.
.DESCRIPTION
This script checks port on the remote computers
.EXAMPLE
TestRemotePort -ComputerName ServerName -Port 8080
.PARAMETER ComputerName
Remote Server Name
.PARAMETER Port
Remote port number
.INPUTS
ComputerNames can be passed and a port can be passed
.OUTPUTS
True or False
#>
Test-NetConnection -ComputerName $ComputerName -Port $Port
}

Çıktı:

Yoruma dayalı yardımı betiğin başına da yerleştirebilirsiniz.

Kod:

<#
.DESCRIPTION
This script will test the connection with the remote server
#>
param(
[Parameter(Mandatory=$true)]
[String]$Server
)
Test-Connection -ComputerName $Server -Count 2 -quiet

Çıktı:

Ve yoruma dayalı yardım betiğin sonuna yerleştirilebilir.

Kod:

function TestNetConnection{
Test-Netconnection -ComputerName $computername -Port $port
}
<#
.DESCRIPTION
The above function checks the port on the remote computer.
#>

İlgili makaleler