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

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

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

ไวยากรณ์:

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

เช่น:

#example of single ling comment
Write-Host "The above line won't be printed"
<#
the below lines
won't be printed"
#>
Write-Host "above lines are example of multiline comment r script block"

เอาต์พุต:

การแสดงความคิดเห็นโดยใช้ทางลัด:

หากต้องการแสดงความคิดเห็นทีละบรรทัด (#) ให้เลือกหนึ่งบรรทัดขึ้นไปแล้วกด Ctrl + Q หรือคลิกความคิดเห็น (ในส่วนแก้ไขของแท็บหน้าแรก) ไฮไลต์บล็อกโค้ดแล้วกด Ctrl + Shift + Alt + Q หรือเลือกบล็อกข้อความเพื่อเพิ่มบล็อกความคิดเห็น (PowerShell Studio เวอร์ชัน 4.1.72 แนะนำไอคอนบล็อกความคิดเห็น) หากต้องการลบความคิดเห็น (ในรูปแบบใดรูปแบบหนึ่ง ) ให้เลือกบรรทัดที่จะลบแล้วกด Ctrl + Delete ความคิดเห็นสามารถลบได้โดยใช้ Ctrl + shift + Q หรือเลือกบล็อกและเลือกไม่แสดงความคิดเห็นจากหน้าต่างตัวเลือก

การเพิ่มข้อความอธิบายสำหรับความคิดเห็น:

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

ตัวอย่าง:

<# This script will copy items from one site collection to another.
WARNING: Don’t run this in production using system account.
Last update: Feb 14, 2021
Last Updated By: Vignesh Krishnakumar
Last run time: 1 hour 30 mins
Duration: Run every month 15th
Inputs to be supplied: Source site, destination site
Output location: C:\output
#>

การสร้างความคิดเห็นเพื่อจุดประสงค์ด้านเอกสารประกอบ:

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

ตัวอย่าง:

อินพุต:

<#

ฟังก์ชันนี้จะดึงข้อมูลประจำตัวจากไฟล์ XML ด้วยวิธีการเข้ารหัสเพื่อเชื่อมต่อกับระบบ

ในกรณีที่ไม่มีไฟล์ XML โปรดดำเนินการตามด้านล่างนี้

1. เปิด PowerShell ในฐานะผู้ดูแลระบบ
2. เรียกใช้คำสั่งนี้ - 'Get-Credential | Export-CliXml .\test.XML'
3. บันทึกเอาต์พุตในโฟลเดอร์เดียวกันกับสคริปต์
4. เมื่อได้รับข้อมูลรับรองแล้ว ให้เรียกใช้ฟังก์ชันหลัก
5. เมื่อสคริปต์ได้รับแล้ว รันสำเร็จแล้ว ให้ไปตรวจสอบบันทึกในเส้นทางบันทึก
6. ในกรณีที่มีข้อผิดพลาด ให้คัดลอก ID แล้วไปตรวจสอบใน CRM

หมายเหตุ: ใช้งานได้เฉพาะในคอมพิวเตอร์เครื่องเดียวกันเท่านั้น
#>

แนวทางปฏิบัติที่ดีที่สุดสำหรับการแสดงความคิดเห็น

อย่าใช้หมายเลขบรรทัดในความคิดเห็น:

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

อย่าเพิ่มความคิดเห็นต่อท้ายสคริปต์:

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

หลีกเลี่ยงความคิดเห็นที่ท้ายบรรทัด:

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

หลีกเลี่ยงความคิดเห็นหากไม่จำเป็น:

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

ความช่วยเหลือตามความคิดเห็นสำหรับฟังก์ชันและสคริปต์:

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

บทสรุป

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

บทความแนะนำ

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