Python Comment: คู่มือทีละขั้นตอนสำหรับการเขียนคอมเมนต์

Python comment คือบรรทัดของข้อความในโปรแกรมที่ไม่ถูกรันโดยตัวแปลภาษา (interpreter) คอมเมนต์ถูกใช้ระหว่างการดีบัก (debugging) เพื่อระบุปัญหาและอธิบายโค้ด คอมเมนต์เริ่มต้นด้วยอักขระแฮช (#)

วิธีเขียนคอมเมนต์ใน Python (How to Comment in Python)

คอมเมนต์แสดงหมายเหตุหรือโค้ดที่คุณไม่ต้องการให้ Python รัน ตัวอย่างเช่น สมมติว่าคุณกำลังเขียนขั้นตอนที่ซับซ้อนเป็นเวลาหลายชั่วโมง คุณอาจต้องการเขียนคอมเมนต์บางอย่างเพื่อติดตามว่าแต่ละบรรทัดของโค้ดทำอะไร เพื่อที่คุณจะไม่หลงลืม

การเขียนคอมเมนต์มีประโยชน์หลายเหตุผล หากคุณกำลังทำงานกับโปรแกรม Python ขนาดใหญ่ การคอมเมนต์สามารถช่วยคุณติดตามสิ่งที่กำลังเกิดขึ้น การคอมเมนต์ยังช่วยให้สมาชิกในทีมมั่นใจว่าทุกคนเข้าใจงานของกันและกันในโปรเจกต์ร่วมมือ (collaborative project)

นักพัฒนาทุกคนจะเผชิญสถานการณ์ที่พวกเขาต้องรวมคอมเมนต์เมื่อเขียนโค้ด

แต่คุณจะคอมเมนต์โค้ดใน Python ยังไง? เหมือนภาษาโปรแกรมมิ่งอื่นๆ Python รองรับการคอมเมนต์ ในคู่มือนี้ เราจะพูดถึงการเขียนคอมเมนต์ใน Python

Python Comment คืออะไร? (What is a Python Comment?)

Python comment คือบรรทัดของข้อความที่ปรากฏในโปรแกรมแต่ไม่ถูกรันโดยโปรแกรม คุณสามารถประกาศคอมเมนต์ได้โดยใช้แฮชแท็ก (#) คอมเมนต์สามารถปรากฏบนบรรทัดใหม่หรือท้ายบรรทัดของโค้ดที่มีอยู่

คอมเมนต์ถูกใช้เพื่ออธิบายว่าโค้ดทำงานอย่างไร และเพื่อวัตถุประสงค์ในการทดสอบ

นี่คือตัวอย่างคอมเมนต์บรรทัดเดียวใน Python:

# This is a demo comment

คุณเห็นเครื่องหมายแฮช # แสดงถึงคอมเมนต์ของเรา เราแยกข้อความคอมเมนต์และเครื่องหมาย # ด้วยช่องว่าง นี่ไม่จำเป็นแต่มันทำให้แต่ละคอมเมนต์อ่านง่ายขึ้น

บรรทัดนี้ถูกข้ามโดยคอมไพเลอร์เมื่อเรารันโค้ดของเรา คอมเมนต์เป็นสำหรับมนุษย์อ่าน ไม่ใช่สำหรับโปรแกรมรัน

คอมเมนต์ควรเพิ่มที่ระดับการเยื้อง (indent level) เดียวกับโค้ดที่คอมเมนต์อ้างอิงถึง ตัวอย่างเช่น สมมติว่าคุณกำลังเขียนเกี่ยวกับบรรทัดโค้ดภายในคำสั่ง if คุณจะเยื้องคอมเมนต์ของคุณในลักษณะเดียวกับที่คุณทำกับโค้ดของคุณ

ตัวอย่าง Python Comments (Python Comments Example)

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

ในลูป for ของ Python คุณอาจมีคอมเมนต์ที่ดูเหมือนนี้:

# Define students variable as an array of strings
students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]
# Loop through each item in the students array and print out each name
for s in students:
    print("Student Name: ", s)

คอมเมนต์ของเราช่วยให้เราเข้าใจวัตถุประสงค์ของโค้ดของเราและติดตามสิ่งที่กำลังเกิดขึ้น

มาใช้ตัวอย่างเพื่อแสดงโครงสร้างการเยื้องของคอมเมนต์ใน Python ในตัวอย่างด้านล่าง โปรแกรมของเราวนซ้ำผ่านสองอาร์เรย์ Python และให้แต่ละนักเรียน pass หรือ fail สำหรับการทดสอบของพวกเขา Pass และ fail ถูกกำหนดโดยอิงจากคะแนนตัวเลขของนักเรียนในการทดสอบ:

# Define an array with student names
students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]
# Define an array with student grades
numericalGrades = [55, 72, 64, 86, 86, 59]
# Loop through every student in "students" array
for s in range(0, len(students)):
    # Check if the student's numerical grade is equal to or above 60
    if numericalGrades[s] >= 60:
        # Print a message saying the student has passed their test
        print(students[s], "passed their test.")
    else:
        # Print a message saying the student has failed their test
        print(students[s], "failed their test.")

โปรแกรมนี้รับรายชื่อนักเรียนและเกรดของพวกเขา จากนั้น โปรแกรมของเราวนซ้ำผ่านรายการนักเรียน เราตรวจสอบว่าแต่ละนักเรียนผ่านหรือล้มเหลวในการทดสอบ

ในตัวอย่างข้างต้น คุณเห็นได้ว่าเราคอมเมนต์ที่ระดับการเยื้องเดียวกับบรรทัดที่เราอ้างอิงถึง เมื่อเรากล่าวถึงคำสั่ง if ของ Python ตัวอย่างเช่น เราได้เยื้องคอมเมนต์ของเราเหมือนกับโค้ดของเรา

ด้วยการเขียนคอมเมนต์บรรทัดเดียวเหล่านี้ โปรแกรมของเราอ่านง่ายขึ้นทั้งสำหรับผู้เขียนโค้ด โปรแกรมของเรายังง่ายต่อการอ่านสำหรับคนอื่นที่อาจดูโปรแกรมของเรา

Python Inline Comments (คอมเมนต์บรรทัดเดียวกัน)

Python Inline comments เขียนบนบรรทัดเดียวกับคำสั่ง หลังจากที่โค้ดถูกเขียนแล้ว Inline comments ควรอธิบายวัตถุประสงค์ของบรรทัดโค้ดหรือวิธีการทำงานของมัน

นี่คือไวยากรณ์สำหรับ inline comment:

print(students) # Print the variable "students"

Inline comments มีประโยชน์หากคุณต้องการอธิบายส่วนที่ซับซ้อนของโค้ด พวกเขายังมีประโยชน์หากคุณคิดว่าคุณอาจลืมว่าบรรทัดโค้ดเฉพาะทำงานอย่างไรในอนาคต

Inline comments ยังมีประโยชน์หากคุณกำลังทำงานในทีมและต้องการให้ทุกคนเข้าใจบรรทัดเฉพาะ

ไม่เหมือนประเภทคอมเมนต์อื่นๆ ให้ใช้ inline comments บ้างครั้ง นี่เป็นเพราะ inline comments มากเกินไปทำให้โปรแกรมอ่านยาก

Python Multiline Comments (คอมเมนต์หลายบรรทัด)

Python multiline comments หรือ Python block comments อธิบายโค้ดที่ซับซ้อนกว่าหรือวัตถุประสงค์ไม่ชัดเจนทันที คุณอาจใช้ block comment เพื่ออธิบายฟังก์ชันที่ไม่ซ้ำใครที่ใช้ไลบรารีภายนอก ตัวอย่างเช่น

Block comments เป็นคอมเมนต์หลายบรรทัดใน Python และใช้กับบางส่วนหรือทั้งหมดของโค้ดด้านล่าง Block comments เหมือนคอมเมนต์อื่นๆ ก็ยังเยื้องที่ระดับเดียวกับโค้ดที่คอมเมนต์กำลังอภิปราย

ตัวอย่าง Multiline Comment (Multiline Comment Example)

นี่คือตัวอย่างของสตริงหลายบรรทัดที่อธิบายฟังก์ชัน sort() ของ Python:

# The sortStudents function will parse arguments via the "student" variable. The
# function simply returns the length of each student's name. We reference the sortStudents
# function in the sort() function later in the code, which iterates over each item in the
# "students" array and executes our sortStudents function.
def sortStudents(student):
    return len(student)
students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]
students.sort(key=sortStudents)

คอมเมนต์ของเรากล่าวครอบหลายบรรทัดและอธิบายวัตถุประสงค์ของโค้ดที่เขียนด้านล่าง

ในขณะที่นักพัฒนาบางคนอาจเข้าใจโค้ดนี้ นักโปรแกรมเมอร์คนอื่นอาจสับสนเกี่ยวกับวิธีการทำงานหรือทำไมมันถึงถูกเขียน การใช้ block comment เป็นวิธีที่ดีในการอธิบายขั้นตอนทั้งหมด Block comments มีประโยชน์สำหรับการอธิบายโค้ดอื่นๆ ที่วัตถุประสงค์ไม่ชัดเจนทันทีสำหรับนักพัฒนา

สรุป

นั่นคือวิธีคอมเมนต์ใน Python! ด้วยคอมเมนต์ คุณสามารถทำให้โปรแกรมของคุณอ่านง่ายขึ้นสำหรับทุกคน รวมถึงคุณเอง

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

คุณพร้อมสำหรับการท้าทายไหม? เขียน block comment ที่ด้านบนของโปรแกรมหนึ่งของคุณ คอมเมนต์นี้ควรมี:

• ชื่อของคุณ
• เมื่อคุณสร้างไฟล์
• ชื่อของไฟล์
• วัตถุประสงค์ของไฟล์

ลองรันโค้ดของคุณ หากโปรแกรมของคุณไม่รันเพราะคอมเมนต์ คุณทำผิดพลาด หากโปรแกรมของคุณรันตามปกติ ยินดีด้วย! คุณเขียนคอมเมนต์สำเร็จแล้ว

ในบทช่วยสอนนี้ เราสำรวจวิธีเขียนคอมเมนต์ inline comments และ block comments ใน Python เรายังอภิปรายว่านักพัฒนาบางคนเขียนคอมเมนต์เพื่อการทดสอบ ตอนนี้คุณสามารถเขียนคอมเมนต์อย่างมืออาชีพ Python แล้ว!

มองหาการเชี่ยวชาญภาษาโปรแกรมมิ่ง Python? สำหรับการสนับสนุนหลักสูตร Python อันดับหนึ่ง หนังสือ และทรัพยากรการเรียนรู้ โปรดดูคู่มือ How to Learn Python ที่ครอบคลุมของเรา