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