目次
1. พื้นฐานของการคอมเมนต์ใน Python และความสำคัญของมัน
การคอมเมนต์ใน Python เป็นเครื่องมือสำคัญที่ช่วยให้โค้ดเข้าใจง่ายเมื่อผู้อื่นหรือแม้แต่ตัวเราเองกลับมาดูภายหลัง การเขียนคำอธิบายหรือบันทึกกำกับไว้ช่วยเพิ่มความสามารถในการบำรุงรักษาของโปรแกรม ทำให้การระบุสาเหตุของข้อผิดพลาดและการอธิบายตรรกะเป็นไปอย่างราบรื่น นอกจากนี้ ยังมีประโยชน์เมื่ออยากปิดการทำงานของโค้ดชั่วคราวระหว่างการพัฒนาเพื่อทำการทดสอบ1.1 พื้นฐานของการคอมเมนต์แบบบรรทัดเดียว
คอมเมนต์แบบบรรทัดเดียวใน Python ใช้สัญลักษณ์ # โดยการใส่ # ที่ต้นบรรทัด บรรทัดนั้นทั้งหมดจะถูกมองว่าเป็นคอมเมนต์# นี่คือคอมเมนต์
print("Hello, World!") # ส่วนนี้ก็เป็นคอมเมนต์ด้วย
ดังเช่นนี้ คุณสามารถเพิ่มคอมเมนต์เพื่ออธิบายโค้ดหรือช่วยในงานปรับปรุงในอนาคตได้
1.2 ภาพรวมของคอมเมนต์หลายบรรทัด
สำหรับคอมเมนต์หลายบรรทัด มักใช้วิธีใส่สัญลักษณ์ # แยกในแต่ละบรรทัด วิธีนี้ต้องแทรก # ลงในแต่ละบรรทัดด้วยตนเอง แต่มีประสิทธิภาพมากเมื่ออยากปิดการทำงานของบล็อกโค้ดยาวๆ# นี่คือคอมเมนต์บรรทัดที่ 1
# นี่คือคอมเมนต์บรรทัดที่ 2
# นี่คือคอมเมนต์บรรทัดที่ 3
ยังมีวิธีที่มีประสิทธิภาพหลายอย่างเพื่อลดความยุ่งยากของคอมเมนต์หลายบรรทัด ซึ่งจะอธิบายในภายหลัง
2. สองวิธีในการคอมเมนต์หลายบรรทัดใน Python
การคอมเมนต์หลายบรรทัดมีเทคนิคที่สะดวกหลายแบบ ต่อไปนี้จะแนะนำวิธีที่ใช้กันบ่อย 2 วิธี2.1 คอมเมนต์หลายบรรทัดด้วย「#」
การคอมเมนต์หลายบรรทัดด้วย「#」เป็นวิธีที่เรียบง่ายและใช้กันทั่วไปมากที่สุด# นี่คือคอมเมนต์บรรทัดที่ 1
# นี่คือคอมเมนต์บรรทัดที่ 2
# นี่คือคอมเมนต์บรรทัดที่ 3
อย่างไรก็ตาม หากมีจำนวนบรรทัดมาก วิธีนี้จะยุ่งยาก จึงเหมาะกับบล็อกที่มีขนาดค่อนข้างเล็ก2.2 คอมเมนต์หลายบรรทัดด้วยอัญประกาศสามตัว
ใน Python สามารถคอมเมนต์หลายบรรทัดได้โดยใช้อัญประกาศเดี่ยว(”’)หรืออัญประกาศคู่(”””)จำนวนสามตัวเรียงกัน เดิมทีสิ่งนี้ถูกใช้เป็นสตริงเอกสาร(docstring)แต่ก็ใช้เป็นทางเลือกแทนการคอมเมนต์ได้เช่นกัน"""
ตรงนี้เป็นคอมเมนต์หลายบรรทัด
สามารถทำให้หลายบรรทัดไม่ทำงานได้
"""
อย่างไรก็ตาม วิธีนี้จะถูกตีความว่าเป็นสตริง ดังนั้นโดยเคร่งครัดแล้วจึงไม่ใช่คอมเมนต์ อาจทำให้โค้ดใช้ทรัพยากรโดยไม่จำเป็น ดังนั้นควรระมัดระวังเป็นพิเศษในโปรเจกต์ขนาดใหญ่หรือกรณีที่การใช้หน่วยความจำมีความสำคัญ3. ข้อผิดพลาดที่พบบ่อยขณะคอมเมนต์เอาต์ใน Python และวิธีหลีกเลี่ยง
มีหลายจุดที่ควรระวังเมื่อทำการคอมเมนต์เอาต์ โดยเฉพาะข้อผิดพลาดเกี่ยวกับอินเดนต์และการใช้เครื่องหมายอัญประกาศสามตัว จำเป็นต้องระมัดระวังเป็นพิเศษ3.1 การหลีกเลี่ยงข้อผิดพลาดของอินเดนต์
Python มีกฎที่เข้มงวดเกี่ยวกับอินเดนต์ และหากโค้ดไม่ได้อินเดนต์อย่างเหมาะสมจะเกิด IndentationError การคอมเมนต์เอาต์ด้วยอัญประกาศสามตัวก็เช่นกัน หากอินเดนต์ผิดเพี้ยนไปอาจทำให้เกิดข้อผิดพลาดที่ไม่คาดคิดdef example():
"""
ตรงนี้เป็นคอมเมนต์
"""
print("Hello, World!") # บรรทัดนี้จะทำให้เกิด IndentationError
การจัดอินเดนต์ให้สม่ำเสมอเป็นสิ่งที่สำคัญมากใน Python3.2 ปัญหาการใช้ทรัพยากรเมื่อใช้เครื่องหมายอัญประกาศสามตัว
การคอมเมนต์เอาต์ด้วยอัญประกาศสามตัวจะถูกอินเทอร์พรีเตอร์ของ Python มองว่าเป็นสตริง ทำให้ใช้หน่วยความจำ ดังนั้นควรหลีกเลี่ยงการใช้วิธีนี้บ่อยๆ กับบล็อกโค้ดขนาดใหญ่ วิธีนี้เหมาะสำหรับใช้เป็นเอกสารประกอบมากกว่าการคอมเมนต์เอาต์