วิธีเขียน Comments ใน Java: คู่มือฉบับสมบูรณ์

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

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

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

บทช่วยสอนนี้จะอภิปรายวิธีเขียน comments ใน Java และเดินทางผ่าน best practices เล็กน้อยที่คุณสามารถใช้เพื่อเขียน comments ที่มีประสิทธิภาพ

Java Comments

หากคุณใหม่ในการเขียนโปรแกรม คุณอาจถามตัวเองว่า: ทำไมคุณควร comment โค้ด? มีเหตุผลสองประการว่าทำไม code comments จึงสำคัญที่จะเขียน

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

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

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

81% ของผู้เข้าร่วมระบุว่ารู้สึกมั่นใจมากขึ้นเกี่ยวกับโอกาสงานทางเทคโนโลยีหลังจากเข้าร่วมบูทแคมป์ ได้รับการจับคู่กับบูทแคมป์วันนี้

นักศึกษาจบบูทแคมป์เฉลี่ยใช้เวลาน้อยกว่า 6 เดือนในการเปลี่ยนอาชีพ ตั้งแต่เริ่มบูทแคมป์จนหางานแรก

Comments ที่ดีที่สุดคือ comments ที่อธิบายเจตนาด้านหลังโค้ดของคุณ ทำไมคุณทำบางอย่างด้วยวิธีเฉพาะ แทนที่จะแค่ซ้ำว่าบรรทัดโค้ดทำอะไร Comments ที่มีประสิทธิภาพตอบคำถามและปรับปรุงประสิทธิภาพ

Java Comment Syntax

ใน Java มีสองประเภทของ doc comments ที่สามารถเขียนได้: single-line comments และ multi-line comments

Single-Line Comments

Single-line comments มักเรียกว่า inline comments ปรากฏที่ท้ายบรรทัดของโค้ด

Inline comments มักใช้ annotate ส่วนเล็กๆ ของโค้ดที่ใช้หนึ่งหรือสองบรรทัด

สมมติว่าเรากำลังเขียนโปรแกรมที่พิมพ์ข้อความ It’s Friday ออกมาที่ console เราต้องการเขียน comment เพื่อติดตามโค้ดของเรา นี่คือตัวอย่าง inline comment ที่เราสามารถใช้ได้:

public class FridayMessage { public static void main(String[] args) { System.out.println("It's Friday!"); // prints "It's Friday" to the console } } 

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

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

Multi-Line Comments

Multi-line comments หรือที่รู้จักในชื่อ block comments คือ comments ที่ใช้เพื่ออธิบายส่วนของโค้ด Multi-line comments จะคงอยู่หลายบรรทัด และมักวางที่ด้านบนของไฟล์หรือก่อนบล็อกโค้ดเริ่มต้น

Multi-line comments เริ่มด้วย /* และจบด้วย */ นี่คือตัวอย่าง multi-line comment ใน Java source file:

/* This is an example multi-line comment.

    The code below prints out It’s Friday! to the console.

*/

public class FridayMessage { public static void main(String[[ args) { System.out.println("It's Friday!"); } } 

ในตัวอย่างนี้ comments ของเราปรากฏที่สามบรรทัดแรกของโค้ดของเรา

บ่อยครั้ง multi-line comments จะถูกใช้ที่เริ่มต้นของไฟล์เพื่อบันทึกรายละเอียดเกี่ยวกับไฟล์เอง ตัวอย่างเช่น multi-line comment อาจรวมข้อมูลเกี่ยวกับผู้เขียนไฟล์ เวอร์ชันของไฟล์ และข้อมูลคล้ายกัน

Commenting Code สำหรับการทดสอบ

นอกจากการทำหน้าที่เป็นวิธีการจัดทำเอกสาร comments ยังถูกใช้เพื่อป้องกันโค้ดไม่ให้ execute ในช่วง testing และ debugging phases ของการพัฒนาซอฟต์แวร์ นักเขียนโค้ดเรียกสิ่งนี้ว่า commenting out code.

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

class FridayMessage { public static void main(String[[ args) { String day_of_the_week = "Friday"; // System.out.println("It's " ++ day_of_the_week); } } 

ในตัวอย่างนี้ เรา comment out บรรทัดโค้ดที่เริ่มด้วย System.out.println โค้ดของเราส่งคืน error (เพราะเราใช้ ++ สองตัวแทนหนึ่ง) และเรา comment out โค้ดขณะที่เราหาแหล่งที่มาของ error

Commenting out code สามารถช่วยได้มากโดยเฉพาะเมื่อคุณกำลังวิเคราะห์ logic ของโปรแกรม ในสถานการณ์เหล่านี้ คุณอาจต้องการ comment out multiple iterations ของโค้ดของคุณจนกว่าคุณจะหา iteration ที่มีประสิทธิภาพที่สุด หลังจากจุดนั้น คุณสามารถลบโค้ดเก่าของคุณได้

คุณควร comment code out เฉพาะในช่วง testing และ debugging phases การทิ้ง commented out code ในโปรแกรมสุดท้ายอาจทำให้สับสนสำหรับนักพัฒนาคนอื่น และทำให้โค้ดอ่านยากขึ้น

สรุป

ใน Java มีสองประเภทของ comments: single-line (หรือ inline) comments และ multi-line (หรือ block) comments Comments นี้ใช้เพื่อจัดทำเอกสารโค้ดของคุณ และยังสามารถใช้ช่วยคุณในช่วง testing และ debugging phases ของการพัฒนาซอฟต์แวร์ได้

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

ตอนนี้คุณพร้อมที่จะเริ่มเขียน comments ใน Java อย่างมืออาชีพแล้ว!