ความคิดเห็นแบบหลายบรรทัดของ PowerShell | คำแนะนำเกี่ยวกับความคิดเห็น PowerShell MultiLine

ข้อมูลเบื้องต้นเกี่ยวกับความคิดเห็นแบบหลายบรรทัดของ PowerShell

ความคิดเห็นหลายบรรทัดของ PowerShell เป็นวิธีการเพิ่มคำอธิบายของสคริปต์ ฟังก์ชัน หรือการเขียนตัวช่วยในการอธิบายฟังก์ชันการทำงานเพื่อให้เกิดความเข้าใจที่ดีขึ้น และการอธิบายสคริปต์หรือส่วนของสคริปต์โดยไม่ต้องดำเนินการส่วนนั้น และนอกจากนั้นก็คือ มีประโยชน์ในการเขียนวิธีใช้ตามความคิดเห็นเกี่ยวกับฟังก์ชันโดยการเพิ่มไวยากรณ์ พารามิเตอร์ ตัวอย่าง ฯลฯ

ไวยากรณ์:

ความคิดเห็นหลายบรรทัดมีการอธิบายไว้ภายในบล็อก <#…#>

ความช่วยเหลือ ตามความคิดเห็น

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

ความคิดเห็นแบบหลายบรรทัดทำงานอย่างไรใน PowerShell

หากต้องการเพิ่มความคิดเห็นบรรทัดเดียว เราใช้ # นำหน้าบรรทัด และใน PowerShell 2.0 หรือเวอร์ชันก่อนหน้า นี่เป็นวิธีเดียวที่จะเพิ่มความคิดเห็นหลายบรรทัด ซึ่งหมายความว่า หากคุณมีคำอธิบายของ 10 บรรทัด คุณจะต้องใส่ 10 คูณ '#' ไว้หน้าบรรทัด

ความคิดเห็นบรรทัดเดียว '#' ยังคงมีไว้สำหรับอธิบายส่วนเล็กๆ ของฟังก์ชันหรือสคริปต์ ดูว่าความคิดเห็นบรรทัดเดียวด้านล่างมีลักษณะอย่างไร

# This part won't be executed

เอาต์พุต:

แม้แต่นิพจน์หรือไวยากรณ์ใดๆ ก็จะไม่ดำเนินการภายในบล็อกนี้

# Get-Date

เอาต์พุต:

เมื่อใดก็ตามที่ PowerShell ค้นหาคำหลัก # หรือเนื้อหาใดๆ ระหว่างคำหลัก <#…#> ก็จะข้ามส่วนนั้นไปดำเนินการ

ตอนนี้สมมติว่าเรามีสคริปต์และจำเป็นต้องอธิบายบางอย่างเกี่ยวกับเรื่องนี้ หากเราใช้ความคิดเห็นแบบบรรทัดเดียว คุณพอจะเดาได้ไหมว่าการเขียนทุกครั้งที่ # อยู่ในบรรทัดนั้นดูไร้สาระอย่างไร

นี่คือวิธีที่เราต้องใส่เครื่องหมาย # ในแต่ละบรรทัดโดยการเพิ่มความคิดเห็นหลายบรรทัด <#…#> ในสคริปต์ เราสามารถหลีกเลี่ยง #< ลงชื่อทุกครั้ง

บางสิ่งที่ควรทราบ:

• คุณไม่สามารถจัดรูปแบบแบบอักษรที่ความคิดเห็นที่ป้อนภายในบล็อกได้ ลองสร้างฟอนต์เป็นตัวหนา เปลี่ยนสีฟอนต์ มันจะใช้งานไม่ได้เพราะเป็นรูปแบบเฉพาะสำหรับเอดิเตอร์แต่ละคน การแสดงสีของบล็อกความคิดเห็นขึ้นอยู่กับโปรแกรมแก้ไขที่เราใช้และธีมที่คุณเลือก

ความคิดเห็นแบบหลายบรรทัดหรือบรรทัดเดียวอาจดูแตกต่างออกไปในโค้ด PowerShell ISE และ Visual Studio ด้านล่างนี้คือความคิดเห็นหลายบรรทัดจากโค้ด PowerShell ISE และ VS

<# ความคิดเห็นนี้มาจาก PowerShell ISE

สีตัวอักษรแตกต่างจากรหัส VS

-

จากโค้ด VS ด้วยธีม Atom

<# This comment is from the VS code
Font color is different than PowerShell ISE
#>

• คุณไม่สามารถส่งค่าตัวแปรใดๆ ภายในบล็อกความคิดเห็นหลายบรรทัดได้ ตัวอย่างเช่น,

$name = "PowerShell"
<#
This $name variable won't expand because
This is a multiline comment
#&gt

เอาต์พุตไม่สามารถขยายชื่อได้

ตัวอย่าง

ให้เราหารือเกี่ยวกับตัวอย่างของ PowerShell MultiLine Comment

ตัวอย่าง #1: การเพิ่มความคิดเห็นหลายบรรทัดเพื่ออธิบายสคริปต์

เมื่อคุณเขียนสคริปต์ คุณสามารถอธิบายข้อมูลสคริปต์ เช่น เวอร์ชัน ฟังก์ชันการทำงาน พร้อมความคิดเห็นแบบหลายบรรทัดดังที่แสดงด้านล่าง และคุณสามารถใช้งานได้กี่ครั้งก็ได้ เนื่องจากไม่มีขีดจำกัด

นี่คือการรวมกันของความคิดเห็นเดี่ยวและหลายบรรทัด

<#
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

ตัวอย่าง #2: ทางลัดเพื่อเพิ่มความคิดเห็นหลายบรรทัด

ในโค้ด Visual Studio มีทางลัดสำหรับเพิ่มความคิดเห็นแบบหลายบรรทัดโดยเลือกบรรทัดที่เราต้องการแสดงความคิดเห็น จากนั้นกดปุ่ม ALT + SHIFT + A

ตัวอย่างเช่น,

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

เราจำเป็นต้องแสดงความคิดเห็นในบรรทัดข้างต้น ขั้นแรก เลือกบรรทัดเหล่านั้นแล้วกด ALT + SHIFT + A

เอาต์พุต:

ตัวอย่าง #3: การเพิ่มความคิดเห็นหลายบรรทัดสำหรับคำอธิบายวิธีใช้

ความคิดเห็นแบบหลายบรรทัดยังมีประโยชน์ในการเขียนความช่วยเหลือตามความคิดเห็นดังที่แสดงด้านล่าง มีความเฉพาะเจาะจงและอธิบายด้วย.HelpName

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
#>
}

เมื่อคุณตรวจสอบวิธีใช้ที่เกี่ยวข้องกับฟังก์ชันนี้ วิธีใช้ตามความคิดเห็นด้านบนจะมีประโยชน์สำหรับการอธิบายฟังก์ชัน

หากต้องการทราบข้อมูลเพิ่มเติมเกี่ยวกับหัวข้อนี้ โปรดใช้ลิงก์ด้านล่าง

microsoft.powershell.core

บทสรุป

ไม่เพียงแต่ PowerShell แต่ภาษาการเขียนโปรแกรมระดับสูงอื่นๆ เกือบทั้งหมดยังใช้ความคิดเห็นบรรทัดเดียวและหลายบรรทัด ดังนั้นเมื่อเราเขียนสคริปต์ เราไม่จำเป็นต้องพิมพ์ทุกอย่างบนคอนโซลเอาต์พุต แต่เราต้องการผู้ใช้หรือผู้เขียนสคริปต์เพื่อทำความเข้าใจว่าสคริปต์ใดโดยเฉพาะ มีไว้เพื่อ คุณสามารถพูดถึงเวอร์ชันสคริปต์ได้ นอกจากนี้คุณยังสามารถเพิ่มความช่วยเหลือเกี่ยวกับสคริปต์ได้อีกด้วย