อ่านบทความเรื่อง Best practices for writing code comments จาก StackOverflowทำการสรุปและคำแนะนำเกี่ยวกับการเขียน comment ใน code ที่ดีเพื่อช่วยให้คุณภาพของ code ดีขึ้น มีประโยคที่น่าสนใจคือการเขียน comment ที่แย่ ๆ มันแย่กว่าการไม่เขียนอีกนะดังนั้นเราไม่ควรเขียน comment ใช่หรือไม่ ?เพราะว่า แม้จะเขียนไม่ดี compiler ก็ไม่ได้ตรวจสอบให้ถ้า comment ไม่ตรงกับการทำงานจริง ก็ไม่มีอะไรเกิดขึ้นดังนั้นการเขียนมันใช้ทั้งเวลาและความพยายาม !!
Read More…
จากคำถามใน Quora.com เรื่อง What is the best comment in source code that you have ever encountered ? ว่าด้วยเรื่องการ comment ใน source code ที่ดี มันเป็นคำถามที่ดีมาก ๆ รวมทั้งคำตอบต่าง ๆ ก็น่าสนใจ แต่ก็มีบางคำตอบที่ฮา ๆ เยอะเช่นกัน มาดูกันหน่อยสิ
Read More…
จากการ review code จำนวนหนึ่ง จากการแก้ไขและปรับปรุง code จำนวนหนึ่ง พบว่าการเพิ่ม comment ใน code มันเป็นสาเหตุหนึ่งที่ส่งผลให้คุณภาพของ code แย่ลง ซึ่งมักจะมีรูปแบบดังนี้
Read More…
