การเขียนความคิดเห็นในสคริปต์ทุบตี

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

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

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

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

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

เราจะพูดถึงพื้นฐานของการเขียนความคิดเห็นใน Bash

การเขียนความคิดเห็นใน Bash

Bash จะไม่สนใจทุกสิ่งที่เขียนหลังเครื่องหมายแฮช ( # ) บนบรรทัด ข้อยกเว้นสำหรับกฎนี้คือเมื่อบรรทัดแรกของสคริปต์เริ่มต้นด้วย #! ตัวละคร ลำดับของตัวละครนี้เรียกว่า Shebang และใช้เพื่อบอกระบบปฏิบัติการว่าล่ามใช้เพื่อแยกส่วนที่เหลือของไฟล์อย่างไร

ความคิดเห็นสามารถเพิ่มที่จุดเริ่มต้นในบรรทัดหรือแบบอินไลน์ด้วยรหัสอื่น ๆ:

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

ช่องว่างหลังเครื่องหมายแฮชไม่ได้บังคับ แต่จะช่วยปรับปรุงความสามารถในการอ่านของความคิดเห็น

โดยปกติเมื่อเปิดสคริปต์ในโปรแกรมแก้ไขข้อความความคิดเห็นจะแสดงเป็นสีเขียว

ความคิดเห็นยังมีประโยชน์เมื่อทดสอบสคริปต์ แทนที่จะลบบางบรรทัดหรือบล็อกคุณสามารถคอมเม้นท์เหล่านี้ได้:

# if]; then # echo "Variable is greater than 10." # fi

Multiline คอมเม้นท์ใน Bash

ซึ่งแตกต่างจากภาษาโปรแกรมส่วนใหญ่ Bash ไม่สนับสนุนความคิดเห็นหลายบรรทัด

วิธีที่ง่ายที่สุดในการเขียนความคิดเห็นหลายบรรทัดใน Bash คือการเพิ่มความคิดเห็นทีละรายการ:

# This is the first line. # This is the second line.

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

<< 'MULTILINE-COMMENT' Everything inside the HereDoc body is a multiline comment MULTILINE-COMMENT

การใช้ HereDoc นั้นเป็นการแฮกไม่ใช่วิธีการเขียนข้อคิดเห็นแบบหลายบรรทัดในตัว เพื่อหลีกเลี่ยงปัญหาใด ๆ คุณควรใช้ความคิดเห็นบรรทัดเดียว

ข้อสรุป

การเขียนความคิดเห็นเป็นแนวปฏิบัติที่ดีและช่วยให้นักพัฒนาซอฟต์แวร์รายอื่นรวมถึงตัวตนในอนาคตเข้าใจสคริปต์เชลล์ ใน Bash ทุกอย่างหลังจากเครื่องหมายแฮช ( # ) และจนถึงจุดสิ้นสุดของบรรทัดถือว่าเป็นความคิดเห็น

หากคุณมีคำถามหรือข้อเสนอแนะอย่าลังเลที่จะแสดงความคิดเห็น

bash terminal