บทความ IT เจ๋งๆ
10 เทคนิคเขียน Python Code ให้อ่านง่ายและชัดเจนขึ้น
19-มี.ค.-26
คัมภีร์เทพ IT
Code ที่ดีนั้น ไม่ใช่แค่ทำงานได้ แต่ต้อง “อ่านแล้วสามารถเข้าใจได้ในทันที” ด้วย บทความนี้จึงได้รวบรวม 10 เทคนิคเขียน Python Code ให้อ่านง่ายและชัดเจนขึ้น ซึ่งสิ่งนี้จะช่วยลดความซับซ้อน และทำให้ทั้งตัวคุณและทีมงาน ทำงานได้ง่ายและสะดวกขึ้นในระยะยาว
1. ใช้ Object ที่สื่อความหมายแทนการใช้ Boolean Flag
ง่าย ๆ เลย คือ Boolean Flags เป็นสิ่งที่ทำลาย Readability ของ Code
ลองตอบคำถามนี้โดยไม่เลื่อนกลับไปดู:
fast=True, safe=False ในที่นี้ หมายความว่าอะไร?
แทนที่จะใช้แบบนั้น ให้ใช้ Object ที่สื่อความหมายโดยตรงแทน:
โดยทั่วไป สมองของคนเราจะตีความจาก “คำ” ไม่ใช่ “ค่า Boolean” ซึ่งวิธีนี้จะช่วยลดภาระในการคิดและทำความเข้าใจได้ในทันที
2. ใช้ Guard Clause เพื่อลดความซับซ้อนของ Logic
การใช้คำสั่ง if ซ้อนกันหลายชั้น จะทำให้เกิดอุปสรรคย่อม ๆ ในการทำความเข้าใจ Code
แบบที่ไม่แนะนำ:
แบบที่อ่านง่าย:
Code ที่เรียบง่าย คือ Code ที่อ่านและทำความเข้าใจได้ง่าย
สายตาของคุณไม่ควรต้องใช้ “แผนที่” ในการไล่ดู Logic
3. ใช้ตัวแปรตั้งแต่เนิ่น ๆ แยกออกมา ดีกว่าเขียน Logic ทุกอย่างรวมไว้ด้วยกันในบรรทัดเดียว
การเขียน Logic ทุกอย่างรวมไว้ด้วยกันในบรรทัดเดียว อาจดูฉลาด
แต่ในหลายกรณี มันมักจะทำให้อ่านแล้วไม่เข้าใจ
Code ที่อ่านง่ายจะมี จุดที่ช่วยให้เข้าใจความหมายของ Logic
มันไม่ได้หมายถึงว่า คุณกำลัง “เพิ่มจำนวนบรรทัด” แต่ที่จริง คุณกำลังเพิ่ม “ความชัดเจน” ให้กับ Code มากกว่า
4. ใช้ _ เพื่อบอกว่า “มีค่านี้อยู่ แต่เราไม่ได้นำมาใช้”
Underscore (_) ใน Python ไม่ได้มีไว้ตกแต่ง Code เฉย ๆ แต่ใช้เพื่อสื่อความหมายบางอย่าง
หรือใช้ตอนแยกค่าจากหลายตัวแปร:
สิ่งนี้กำลังบอกคนที่มาอ่าน Code ในภายหลังว่า: “ใช่ มีค่าอยู่ตรงนี้ แต่มันไม่ได้สำคัญสำหรับ Logic นี้”
ความตรงไปตรงมาแบบนี้สำคัญมาก
5. แทนการเขียน Comment ด้วยการแยกเป็น Function
ถ้าคุณรู้สึกอยากเขียน Comment เพื่ออธิบาย Code ของคุณ
นั่นคือหนึ่งในสัญญาณว่า ควรแยกพวกมันออกมาเป็น Function
แบบที่ไม่แนะนำ:
แบบที่อ่านง่าย:
จะเห็นว่า ตอนนี้ Code ของคุณ สามารถอ่านได้เหมือนภาษาอังกฤษทั่วไป และไม่จำเป็นต้องมี Comment อีกต่อไป
6. ใช้ Named Tuple แทน Dict เมื่อค่าที่ Return มีหลายส่วนและมี Structure แน่นอน
Dictionaries จะซ่อนความหมายไว้เบื้องหลังของ Strings
ทางเลือกที่ช่วยให้อ่านง่าย:
ข้อดีคือ:
- Autocomplete สามารถใช้งานได้
- Refactor ได้ปลอดภัยขึ้น
- คนอ่านแล้วเข้าใจ Structure ได้ทันที
7. ใช้การเว้นบรรทัดเพื่อแบ่งแต่ละส่วนของ Logic ให้เห็นชัดขึ้น
Whitespace ไม่ได้มีไว้เพื่อให้ “สวย” เพียงอย่างเดียว
แต่มันช่วยจัด “จัดโครงสร้างความคิด” ของ Code ได้เหมือน Syntax ในภาษา
เวอร์ชันที่อ่านง่าย:
การเว้นบรรทัดแต่ละครั้ง ช่วยทำให้เห็นว่า Logic ได้ถูกแบ่งออกเป็นส่วน ๆ อย่างชัดเจน ซึ่งสมองของคนเราจะสามารถรับรู้สิ่งนี้ได้โดยอัตโนมัติ
8. ใช้ Constant ที่มีความหมาย แทน Magic Number
Magic Number ทำให้ Code สื่อความหมายผิดเพี้ยน
เลข 3 คืออะไร? ทำไมต้อง 3?
นี่ไม่ใช่แค่เรื่องของ Constant แต่มันคือการบอกเล่าเรื่องราวเบื้องหลังของตัวเลขนั้น
9. อย่าใช้ elif ซ้อนกันหมายชั้นเกินไป
elif จะทำให้โครงสร้างการตัดสินใจถูกซ่อนไว้
ทางเลือกที่ช่วยให้อ่านได้ง่ายกว่า เมื่อ Logic เริ่มซับซ้อน:
ตอนนี้ Behavior ถูกขับเคลื่อนด้วย “Data” ไม่ใช่ if-else ที่ดูยุ่งเหยิง
10. ตั้งชื่อตัวแปรตามสิ่งที่มัน “ทำ” ไม่ใช่แค่ “มันคืออะไร”
ประเภท (Type) สามารถเปลี่ยนได้ แต่บทบาท (Role) มักจะไม่ค่อยเปลี่ยนแปลง
แบบที่ไม่แนะนำ:
แบบที่อ่านง่าย:
หรือแบบที่ดีกว่า:
ชื่อตัวแปรของคุณ ควรจะตอบคำถามได้ว่า:
“ตัวแปรนี้ มีไว้ทำไม?” ไม่ใช่ “มันคืออะไร?”
สรุป
และนี่ก็เป็น 10 เทคนิคเขียน Python Code ให้อ่านง่ายและชัดเจนขึ้น เพราะท้ายที่สุดแล้ว Readability ไม่ใช่เรื่องของสไตล์ แต่คือคุณภาพของ Code ที่ส่งผลต่อทั้ง Development และ Maintenance ดังนั้น การเขียนให้ชัดเจนเสียตั้งแต่วันนี้ จะช่วยลดปัญหาและประหยัดเวลาได้อย่างมากในอนาคต
ที่มา: https://medium.com/
รับตำแหน่งงานไอทีใหม่ๆ ด้วยบริการ IT Job Alert
|
|
อัพเดทบทความจากคนวงในสายไอทีทาง LINE ก่อนใคร
อย่าลืมแอดไลน์ @techstarth เป็นเพื่อนนะคะ
|
|
บทความล่าสุด