ความคิดเห็น Python:คำแนะนำทีละขั้นตอน

ความคิดเห็นของ Python คือบรรทัดข้อความในโปรแกรมที่ล่ามไม่ได้ดำเนินการ ความคิดเห็นจะใช้ในระหว่างการดีบักเพื่อระบุปัญหาและเพื่ออธิบายโค้ด ความคิดเห็นเริ่มต้นด้วยอักขระแฮช (#)

วิธีแสดงความคิดเห็นใน Python

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

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

ในที่สุดนักพัฒนาทุกคนก็พบกับสถานการณ์ที่พวกเขาต้องใส่ความคิดเห็นเมื่อเขียนโค้ด

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

ความคิดเห็นหลามคืออะไร

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

ความคิดเห็นใช้เพื่ออธิบายวิธีการทำงานของโค้ดและเพื่อการทดสอบ

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

81% ของผู้เข้าร่วมกล่าวว่าพวกเขารู้สึกมั่นใจมากขึ้นเกี่ยวกับโอกาสในการทำงานด้านเทคโนโลยีหลังจากเข้าร่วม bootcamp จับคู่กับ Bootcamp วันนี้

ผู้สำเร็จการศึกษาจากหลักสูตร bootcamp โดยเฉลี่ยใช้เวลาน้อยกว่าหกเดือนในการเปลี่ยนอาชีพ ตั้งแต่เริ่มต้น bootcamp ไปจนถึงหางานแรก

# This is a demo comment

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

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

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

ตัวอย่างความคิดเห็นของ Python

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

ใน Python for loop คุณอาจมีความคิดเห็นที่มีลักษณะดังนี้:

# 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 สองชุดและให้ผ่าน .แก่นักเรียนแต่ละคน หรือ ล้มเหลว สำหรับการทดสอบของพวกเขา ผ่านและล้มเหลวจะพิจารณาจากคะแนนตัวเลขของนักเรียนในการทดสอบ:

# 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.")

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

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

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

ความคิดเห็นแบบอินไลน์ของ Python

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

นี่คือไวยากรณ์สำหรับความคิดเห็นแบบอินไลน์:

print(students) # Print the variable "students"

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

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

ไม่เหมือนความคิดเห็นประเภทอื่น ใช้ความคิดเห็นแบบอินไลน์เป็นครั้งคราวเท่านั้น เนื่องจากความคิดเห็นแบบอินไลน์มากเกินไปทำให้โปรแกรมอ่านยาก

ความคิดเห็นหลายบรรทัดของ Python

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

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

ตัวอย่างความคิดเห็นหลายบรรทัด

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

# 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)

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

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

บทสรุป

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

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

คุณพร้อมสำหรับความท้าทายหรือไม่? เขียนความคิดเห็นแบบบล็อกที่ด้านบนของหนึ่งในโปรแกรมของคุณ ความคิดเห็นนี้ควรรวมถึง:

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

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

ในบทช่วยสอนนี้ เราได้สำรวจวิธีเขียนความคิดเห็น ความคิดเห็นแบบอินไลน์ และบล็อกความคิดเห็นใน Python เรายังคุยกันถึงวิธีที่นักพัฒนาบางคนเขียนความคิดเห็นสำหรับการทดสอบ ตอนนี้คุณสามารถเขียนความคิดเห็นเหมือนผู้เชี่ยวชาญ Python!

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