Comments คอมเมนต์ในโค้ด
คอมเมนต์ (Comments) คือข้อความอธิบายในโค้ดที่ Python จะไม่รัน ใช้สำหรับอธิบายโค้ด ทำให้คนอื่น (หรือตัวเราเองในอนาคต) เข้าใจโค้ดได้ง่ายขึ้น การเขียนคอมเมนต์ที่ดีเป็นทักษะสำคัญที่ทำให้โค้ดมีคุณภาพมากขึ้น
ทำไมต้องเขียน Comments
Section titled “ทำไมต้องเขียน Comments”คอมเมนต์มีความสำคัญด้วยหลายเหตุผล:
- อธิบายโค้ดที่ซับซ้อน - ทำให้เข้าใจตรรกะและ algorithm ได้ง่ายขึ้น
- บันทึกเหตุผล - อธิบายว่าทำไมถึงเขียนแบบนี้ ไม่ใช่แค่ทำอะไร
- TODO และ FIXME - จดจำสิ่งที่ต้องทำต่อหรือบั๊กที่ต้องแก้
- ปิดการใช้งานโค้ดชั่วคราว - สำหรับทดสอบหรือ debug
- สร้าง Documentation - อธิบาย function และ class ให้คนอื่นใช้งานได้
- ช่วยการทำงานเป็นทีม - สื่อสารระหว่าง developers
# ตัวอย่างโค้ดที่มีคอมเมนต์ดีdef calculate_shipping_cost(weight, distance, express=False): """ คำนวณค่าขนส่ง
ใช้สูตร: ค่าพื้นฐาน + (น้ำหนัก × อัตราต่อกิโล) + (ระยะทาง × อัตราต่อกม.) ถ้าเป็น express จะคูณ 1.5 """ # อัตราค่าขนส่ง (บาท) BASE_RATE = 50 # ค่าพื้นฐาน WEIGHT_RATE = 10 # ต่อกิโลกรัม DISTANCE_RATE = 0.5 # ต่อกิโลเมตร EXPRESS_MULTIPLIER = 1.5 # ตัวคูณสำหรับ express
# คำนวณต้นทุน cost = BASE_RATE + (weight * WEIGHT_RATE) + (distance * DISTANCE_RATE)
# เพิ่มค่า express ถ้าต้องการ if express: cost *= EXPRESS_MULTIPLIER
return cost
# ทดสอบnormal = calculate_shipping_cost(5, 100)express = calculate_shipping_cost(5, 100, express=True)print(f"ปกติ: {normal:.2f} บาท, Express: {express:.2f} บาท")เข้าสู่ระบบเพื่อดูเนื้อหาเต็ม
ยืนยันตัวตนด้วยบัญชี Google เพื่อปลดล็อกบทความทั้งหมด
Login with Google