Quantcast
Viewing all articles
Browse latest Browse all 2063

TED rule เพื่อการเขียน code ที่ดีขึ้น

Image may be NSFW.
Clik here to view.

Image may be NSFW.
Clik here to view.

วันนี้กลับไปดูเรื่อง Wrting Code for Humans อีกรอบ
เพื่อสรุปประเด็นที่น่าสนใจเพิ่มเติม
หนึ่งในนั้นคือ แนวทางในการเขียน code ที่ดี
เพื่อลดสิ่งรบกวน หรือ code แย่ ๆ รูปแบบต่าง ๆ ใน code ลงไป
นั่นคือแนวทางที่เรียกว่า TED rule

T = Terse  =  code ที่เขียนต้องสั้น กระชับ ได้ใจความ
E = Expressive = code ต้องชัดเจน อธิบายถึงสิ่งที่ต้องการสื่อสารและสิ่งที่ทำงาน
D = Do one thing = code ต้องมีหน้าที่การทำงานชัดเจน หรือ ทำเรื่องหนึ่ง ๆ ให้ดีไปเลย

จะสังเกตได้ว่า TED rule นั้น

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

ยกตัวอย่างของสิ่งรบกวนใน code ที่มักเกิดขึ้นประจำ

  • ความซ้ำซ้อน
  • Class/file มีขนาดใหญ่
  • Method ยาว ๆ
  • ความซับซ้อนของ code สูง
  • การตั้งชื่อที่ไม่สื่อถึงการทำงาน
  • การ comment code ที่ไร้ประโยชน์ บางครั้งไม่ตรงกับการทำงานจริง ๆ ของ code
  • เกิด Zombie code หรือ code ที่ถูก comment แต่ไม่ได้ถูกลบออกไป บางครั้งมีเอากลับมาใช้ด้วย !!!

ลองกลับไปดู code ที่เราเขียนหน่อยว่า
เป็นไปตาม TED Rule หรือไม่ ?


Viewing all articles
Browse latest Browse all 2063

Trending Articles