ดีครับดอทคอม

การเขียนคอมเม้นต์ Comment ในภาษา Python

การเขียนคอมเม้นต์ Comment ในภาษา Python

Comment หรือคำอธิบายโค้ด คือข้อความที่ Programmer มักเขียนแทรกไว้ในโค้ดเพื่อกลับมาดูทีหลังจะได้รู้ว่าโค้ดส่วนนั้นเอาไว้ทำอะไร หรือเอาไว้ให้ผู้ที่รับช่วงพัฒนาโปรแกรมต่อดู เพื่อจะได้รู้ความหมายหรือจุดมุ่งหมายในการเขียนโค้ดส่วนนั้น ๆ ซึ่งการเขียนคอมเม้นต์หรือคำอธิบายโค้ดในภาษา Python มี 2 รูปแบบ ดังนี้

Line Comment

Line Comment คือการเขียนคำอธิบายแบบบรรทัดเดียว โดยใช้เครื่องหมาย Hash (#) ซึ่งข้อความตัวอักษรนับตั้งแต่เครื่องหมาย # เป็นต้นไปจนถึงตัวอักษรสุดท้ายในบรรทัดนั้น จะถือว่าเป็นคอมเม้นต์ทั้งหมด จะไม่ถูกนำมาประมวลผล ลักษณะการเขียน Line Comment เช่น

# a = 10
# b = 20
# บรรทัดนี้เอาไว้ประกาศตัวแปรและกำหนดค่า
print("Hello World.") # ปริ้นคำว่า Hello World

Block Comment

เป็นการเขียน Comment หรือคำอธิบายที่มีการกำหนดจุดเริ่มต้นและจุดสิ้นสุด ซึ่งจุดเริ่มต้นและจุดสิ้นสุดของ Comment นี้จะใช้เครื่องหมาย Single Quote จำนวน 3 อัน (”’ คำอธิบาย ”’) หรือเครื่องหมาย Double Quotes จำนวน 3 อัน (“”” คำอธิบาย “””) ซึ่งข้อความทั้งหมดที่อยู่ภายในเครื่องหมายดังกล่าว จะถือว่าเป็นคำอธิบายทั้งหมด มีตัวอย่างการใช้งานดังนี้

''' คำอธิบายโดยใช้เครื่องหมาย Single Quote แบบบรรทัดเดียว '''
""" คำอธิบายโดยใช้เครื่องหมาย Double Quotes แบบบรรทัดเดียว """
'''
คำอธิบายโดยใช้เครื่องหมาย 
Single Quote 
แบบหลายบรรทัด
'''
"""
คำอธิบายโดยใช้เครื่องหมาย 
Double Quotes 
แบบหลายบรรทัด
"""

ข้อห้ามของ Block Comment

การเขียนคอมเม้นต์แบบ Block Comment มีข้อห้ามอยู่อย่างหนึ่ง คือ ห้ามเขียนไว้ในบรรทัดเดียวกันกับโค้ด ไม่ว่าจะเป็นข้างหน้าหรือข้างหลังโค้ดก็ตาม เพราะจะเกิด Error ขึ้น

ถ้าจำเป็นต้องเขียน Block Comment ไว้ในบรรทัดเดียวกับกับโค้ด ให้ปิดท้ายโค้ดด้วยเครื่องหมาย Semicolon (;) แล้วค่อยเขียนคอมเม้นต่อท้าย หรือเขียนคอมเม้นไปก่อน แล้วปิดท้ายด้วยเครื่องหมาย Semicolon (;) แล้วค่อยเขียนโค้ดตาม ดังตัวอย่าง

print("Hello World."); '''Block Comment'''
"""Block Comment"""; print("Hello World.")