หลายคนอาจจะมองข้ามคอมเมนต์ในโค้ดของซอฟต์แวร์หรือแอปพลิเคชัน โดยคอมเมนต์หมายถึงส่วนที่เขียนขึ้นมาเพื่ออธิบายโค้ดหรือทำให้ผู้พัฒนาท่านอื่นเข้าใจเพิ่มเติม มันเป็นสิ่งที่สำคัญเป็นอย่างยิ่ง และมักถูกละเลยไปในหลายกรณี ในบทความนี้ เราจะมาทบทวนความสำคัญของคอมเมนต์ในโค้ดและทำไมควรมองอย่างส่วนตัว
ความสำคัญของคอมเมนต์ในโค้ด
การเขียนคอมเมนต์ในโค้ดเป็นสิ่งที่มีความสำคัญมาก โดยเฉพาะเมื่อมีการทำงานเป็นทีมหรือถ้าคุณต้องกลับมาทบทวนโค้ดในภายหลัง คอมเมนต์คือเหมือนคู่มือที่ช่วยอธิบายว่าโค้ดทำงานยังไง มันช่วยให้คนที่มาดูโค้ดต่อมาเข้าใจและจัดการโค้ดได้อย่างง่ายดาย นอกจากนี้ คอมเมนต์ยังช่วยให้เราเข้าใจว่า ทำไมเราต้องเขียนโค้ดแบบนี้ ทำไมต้องใช้วิธีนี้ หรือแม้แต่สิ่งที่ควรใช้งานอย่างอื่นเท่านั้น
ทำไมควรมองข้ามคอมเมนต์
มีหลายสาเหตุที่ทำให้คนมองข้ามคอมเมนต์ในโค้ด อย่างแรก โค้ดที่เขียนขึ้นมาใหม่ๆ และยังไม่ต้องมีการกลับมาทบทวน ส่วนใหญ่คนก็มักจะละเลยการเขียนคอมเมนต์ หรือคิดว่ามันไม่ได้ถูกต้อง แต่จริง ๆ แล้วการที่เราต้องการรู้ว่า เราเขียนโค้ดนี้มาทำไม กลับมาไล่อ่านคอมเมนต์ที่เขียนไว้จะทำให้เข้าใจของเรามากขึ้น
อีกสาเหตุหนึ่งคือ ความกังวลที่คอมเมนต์ทำให้โค้ดดูยุ่งเหยิง ไม่งั้นก็คิดว่า ถ้าโค้ดหมดลงจะสวยขึ้น แต่ความจริงก็ไม่เป็นเช่นนั้นจริง ๆ คอมเมนต์ทำให้คนเข้าใจโค้ดง่ายขึ้น และสามารถทบทวนได้ง่ายขึ้นด้วย
การใช้คอมเมนต์อย่างถูกต้อง
การเขียนคอมเมนต์ก็สำคัญเท่าไร การใช้คอมเมนต์อย่างถูกต้องก็เท่าเท่าเดิม ควรจะเขียนคอมเมนต์ให้เข้าใจง่าย ไม่ต้องใช้ภาษาทางการ โดยมักจะใช้ภาษาทั่วไป ไม่ต้องยุ่งยาก รวมถึงควรระวังการใช้คำบางคำที่อาจจะมีความหมายหลากหลาย เป็นต้น
สรุป
คอมเมนต์ในโค้ดสำคัญมาก โดยไม่ว่าจะเป็นเพื่อดูแล้งเมื่อกลับมาทบทวนโค้ดหรือเพื่อให้ผู้พัฒนาท่านอื่นเข้าใจว่าโค้ดนั้นทำงานยังไง จึงควรจะไม่มองข้ามส่วนนี้ และควรนำมาใช้ในการพัฒนาโปรแกรมให้ดีที่สุดเท่าที่จะเป็นไปได้ การใช้คอมเมนต์ให้ถูกต้องจะช่วยให้การทบทวนโค้ดเป็นเรื่องที่ง่ายและรวดเร็วมากขึ้น
หมายเหตุ: ข้อมูลในบทความนี้อาจจะผิด โปรดตรวจสอบความถูกต้องของบทความอีกครั้งหนึ่ง บทความนี้ไม่สามารถนำไปใช้อ้างอิงใด ๆ ได้ ทาง EPT ไม่ขอยืนยันความถูกต้อง และไม่ขอรับผิดชอบต่อความเสียหายใดที่เกิดจากบทความชุดนี้ทั้งทางทรัพย์สิน ร่างกาย หรือจิตใจของผู้อ่านและผู้เกี่ยวข้อง
หากมีข้อผิดพลาด/ต้องการพูดคุยเพิ่มเติมเกี่ยวกับบทความนี้ กรุณาแจ้งที่ http://m.me/Expert.Programming.Tutor
085-350-7540 (DTAC)
084-88-00-255 (AIS)
026-111-618
หรือทาง EMAIL: NTPRINTF@GMAIL.COM