/ 365วันแห่งโปรแกรม

[365 วันแห่งโปรแกรม] #day1 การเขียน comment

เนื่องในวันที่ 3/14 เป็นวัน ‪#‎PiDay‬ จึงเป็นโอกาสดีที่จะเริ่มอะไรใหม่ๆ ที่คิดได้และทำได้ตอนนี้ก็คือ ‪#‎356วันแห่งโปรแกรม‬ โครงการที่จะโพสต์ข้อความที่เกี่ยวกับงานโปรแกรม ทั้งในเรื่องเทคนิค สิ่งควรรู้ ข้อห้าม นิยาม หรืออะไรก็แล้วแต่ที่มันดูมีประโยชน์(มั้ง) เป็นเวลาอย่างน้อย 365 วัน เอาล่ะเริ่มกันเลยดีกว่า วันแรกนี้ขอเสนอเรื่องการเขียน comment ในโค้ด


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

เมื่อพยายามจะแก้ฟังก์ชันแล้วพบว่า comment ที่อธิบายไว้มันไม่อัพเดท

พอแก้โปรแกรมแล้วต้องมานั่งแก้ comment ต่ออีก

ใน comment มีแต่สิ่งที่รู้อยู่แล้ว

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

ขอเชิญชวนทุกท่านเข้าร่วมโครงการครับ เรามาร่วมกันบันทึกอะไรที่มีประโยชน์กัน เขียนกันเยอะๆ นะครับ แชร์บน social network แล้วใส่ hashtag ‪#‎โครงการ365วันแห่ง‬... ด้วยนะคร้าบบ

‪#‎day1‬ ‪#‎365วันแห่งโปรแกรม‬ #โครงการ365วันแห่ง...