เทคนิคตั้งชื่อฟังก์ชันและตัวแปรให้อ่านง่าย

ทำไมการตั้งชื่อจึงสำคัญ

ชื่อของฟังก์ชันและตัวแปรเป็นตัวแทนของข้อมูลหรือการกระทำบางอย่างในโปรแกรม หากตั้งชื่อไม่ชัดเจน จะทำให้เข้าใจผิดและทำให้เกิดข้อผิดพลาดหรือเสียเวลาในการ Debug ได้ ดังนั้นการตั้งชื่อที่ดีคือพื้นฐานของการเขียนโค้ดที่มีประสิทธิภาพ

เทคนิคการตั้งชื่อตัวแปรให้อ่านง่าย

1. ใช้ชื่อที่สื่อความหมาย

หลีกเลี่ยงการใช้ชื่อทั่วไปอย่าง a, x, temp ถ้าไม่ได้เป็นการใช้งานชั่วคราวหรือเฉพาะเจาะจง แนะนำให้ใช้ชื่อที่สะท้อนถึงสิ่งที่เก็บไว้ เช่น:

• userList แทน u
• totalPrice แทน tp
• isLoggedIn แทน logged

2. ตั้งชื่อตามชนิดของข้อมูล

ช่วยให้เข้าใจประเภทของข้อมูล เช่น:

• count สำหรับตัวเลข
• nameList สำหรับอาร์เรย์หรือรายการ
• isActive สำหรับค่าบูลีน

3. ใช้มาตรฐาน camelCase หรือ snake_case อย่างต่อเนื่อง

เลือกมาตรฐานเดียวแล้วใช้ให้สม่ำเสมอ เช่น:

• userName หรือ user_name
• userAge หรือ user_age

เทคนิคการตั้งชื่อฟังก์ชันให้อ่านง่าย

1. เริ่มต้นด้วยคำกริยา

เพราะฟังก์ชันคือการกระทำ ตัวอย่างเช่น:

• getUserData()
• calculatePrice()
• sendEmail()

2. ใส่บริบทในชื่อเพื่อความชัดเจน

หากฟังก์ชันเกี่ยวข้องกับชุดข้อมูลที่มีชื่อคล้ายกัน ควรเพิ่มคำอธิบายเพิ่มเติมเข้าไป:

• saveUserInfo() แทน saveData()
• deleteCustomerRecord() แทน deleteRecord()

3. หลีกเลี่ยงตัวย่อที่ไม่คุ้นเคย

อาจทำให้ผู้อ่านโค้ดไม่เข้าใจได้ทันที เช่น

ข้อควรระวังในการตั้งชื่อ

1. อย่าใช้ชื่อซ้ำกับคำสงวนของภาษา เช่น class, function, int
2. อย่าตั้งชื่อยาวจนเกินไป ควรพอดีและสื่อความหมายที่ต้องการ
3. อย่าตั้งชื่อหลายภาษาในโค้ดเดียวกัน เช่นผสมระหว่างภาษาไทยและอังกฤษ

หากคุณไม่แน่ใจว่าควรตั้งชื่ออย่างไร ให้ลองถามตัวเองว่า “ฉันจะรู้ไหมว่าโค้ดนี้ทำอะไร เมื่อกลับมาดูอีกครั้งในอีก 3 เดือน?”

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

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