วิธีเขียนความคิดเห็นใน Java

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

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

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

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

ความคิดเห็นของ Java

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

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

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

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

81% ของผู้เข้าร่วมกล่าวว่าพวกเขารู้สึกมั่นใจมากขึ้นเกี่ยวกับโอกาสในการทำงานด้านเทคโนโลยีหลังจากเข้าร่วม bootcamp จับคู่กับ Bootcamp วันนี้

ผู้สำเร็จการศึกษาจากหลักสูตร bootcamp โดยเฉลี่ยใช้เวลาน้อยกว่าหกเดือนในการเปลี่ยนอาชีพ ตั้งแต่เริ่มต้น bootcamp ไปจนถึงหางานแรก

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

ไวยากรณ์ความคิดเห็น Java

ใน Java มีความคิดเห็นเกี่ยวกับเอกสารสองประเภทที่สามารถเขียนได้:ความคิดเห็นบรรทัดเดียวและความคิดเห็นหลายบรรทัด

ความคิดเห็นบรรทัดเดียว

ความคิดเห็นแบบบรรทัดเดียว ซึ่งมักเรียกว่าความคิดเห็นแบบอินไลน์ จะปรากฏที่ท้ายบรรทัดของโค้ด

ข้อคิดเห็นแบบอินไลน์มักใช้เพื่ออธิบายส่วนเล็ก ๆ ของโค้ดซึ่งอยู่เพียงบรรทัดเดียว

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

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

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

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

ความคิดเห็นหลายบรรทัด

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

ความคิดเห็นหลายบรรทัดเริ่มต้นด้วย /* และลงท้ายด้วย */ . ต่อไปนี้คือตัวอย่างความคิดเห็นแบบหลายบรรทัดในซอร์สไฟล์ Java:

/* นี่คือตัวอย่างความคิดเห็นแบบหลายบรรทัด

รหัสด้านล่างพิมพ์ It’s Friday! ไปที่คอนโซล

*/

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

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

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

โค้ดแสดงความคิดเห็นสำหรับการทดสอบ

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

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

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

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

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

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

บทสรุป

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

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

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