Chú thích (comment) Python là dòng văn bản trong chương trình không được thực thi bởi trình thông dịch. Chú thích dùng khi gỡ lỗi (debugging) xác định vấn đề và giải thích mã. Chú thích bắt đầu bằng ký tự thăng (#).
Cách viết chú thích trong Python
Chú thích chỉ ra ghi chú hoặc mã bạn không muốn Python chạy. Ví dụ, bạn viết thủ tục phức tạp trong vài giờ. Bạn có thể viết vài chú thích theo dõi mỗi dòng mã làm gì để không bị mấtOriented.
Viết chú thích hữu ích nhiều lý do. Nếu làm việc với chương trình Python lớn, chú thích giúp theo dõi chuyện gì xảy ra. Chú thích cũng giúp thành viên nhóm hiểu công việc nhau trong dự án cộng tác.
Mọi nhà phát triển cuối cùng gặp tình huống phải bao gồm chú thích khi viết mã.
Nhưng làm thế nào chú thích mã trong Python? Giống mọi ngôn ngữ lập trình, Python hỗ trợ chú thích. Trong hướng dẫn này, chúng ta sẽ nói về viết chú thích trong Python.
Python Comment là gì?
Chú thích Python là dòng văn bản xuất hiện trong chương trình nhưng không được thực thi bởi chương trình. Bạn khai báo chú thích dùng thăng (#). Chú thích có thể xuất hiện dòng mới hoặc cuối dòng mã hiện có.
Chú thích dùng giải thích cách mã hoạt động và cho mục đích kiểm thử.
Ví dụ chú thích một dòng Python:
# This is a demo comment
Bạn thấy dấu thăng # chỉ chú thích. Chúng ta tách văn bản chú thích và dấu # bằng khoảng trắng. Không bắt buộc nhưng làm cho mỗi chú thích dễ đọc hơn.
Dòng này bị trình biên dịch bỏ qua khi chạy mã. Chú thích để người đọc. Không để chương trình thực thi.
Chú thích nên thêm ở cùng mức thụt lề (indent) với mã mà chú thích tham chiếu. Ví dụ, bạn viết về dòng mã trong câu lệnh if. Bạn thụt lề chú thích giống như mã.
Ví dụ Python Comments
Giả sử bạn viết vòng lặp for, muốn nhắc bản thân cách nó hoạt động. Bạn có thể viết vài chú thích. Khi quay lại xem mã sau, bạn đọc ghi chú.
Trong vòng lặp for Python, chú thích có thể trông như sau:
# 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)
Chú thích giúp hiểu mục đích mã và theo dõi chuyện gì xảy ra.
Hãy dùng ví dụ minh họa cấu trúc thụt lề chú thích Python. Ví dụ dưới, chương trình lặp qua hai mảng Python và cho mỗi học sinh pass hoặc fail cho bài kiểm tra. Pass/fail xác định dựa trên điểm số của học sinh:
# 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.")
Chương trình lấy danh sách học sinh và điểm. Sau đó, chương trình lặp qua danh sách học sinh. Kiểm tra mỗi học sinh đỗ hay trượt.
Trong ví dụ trên, thấy chúng ta chú thích cùng mức thụt lề với dòng tham chiếu. Khi thảo luận câu lệnh if Python, ví dụ, thụt lề chú thích cùng mã.
Viết chú thích một dòng này, chương trình dễ đọc hơn cho cả tác giả mã. Chương trình cũng dễ hơn cho người khác xem chương trình.
Python Inline Comments (Chú thích cùng dòng)
Chú thích cùng dòng Python viết trên cùng dòng với câu lệnh, sau khi mã viết xong. Chú thích cùng dòng nên giải thích mục đích dòng mã hoặc cách hoạt động.
Cú pháp chú thích cùng dòng:
print(students) # Print the variable "students"
Chú thích cùng dòng hữu ích nếu cần giải thích phần phức tạp mã. Cũng hữu ích nếu nghĩ quên cách dòng mã cụ thể hoạt động tương lai.
Chú thích cùng dòng cũng hữu ích nếu làm việc nhóm cần đảm bảo mọi người hiểu dòng cụ thể.
Khác loại chú thích khác, chỉ dùng chú thích cùng dòng thỉnh thoảng. Vì quá nhiều chú thích cùng dòng làm chương trình khó đọc.
Python Multiline Comments (Chú thích nhiều dòng)
Chú thích nhiều dòng Python, hoặc Python block comments, giải thích mã phức tạp hơn hoặc mục đích không rõ ràng ngay. Bạn có thể dùng block comment giải thích hàm độc đáo dùng thư viện bên ngoài, ví dụ.
Block comments là chú thích nhiều dòng Python áp dụng cho một phần hoặc toàn bộ mã dưới chúng. Block comments, giống chú thích khác, cũng thụt lề cùng mức với mã chú thích thảo luận.
Ví dụ Multiline Comment
Ví dụ chuỗi nhiều dòng giải thích hàm 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)
Chú thích trải nhiều dòng mô tả mục đích mã viết dưới nó.
Mặc dù một số nhà phát triển hiểu mã này, lập trình viên khác có thể bối rối cách hoạt động hoặc tại sao viết. Dùng block comment là cách tuyệt vời giải thích toàn bộ thủ tục. Block comments hữu ích giải thích bất kỳ mã nào mục đích không rõ ràng ngay cho lập trình viên.
Kết luận
Đó là cách chú thích trong Python! Dùng chú thích, bạn làm chương trình dễ đọc cho mọi người, bao gồm chính bạn.
Chú thích viết tốt giúp theo dõi mã khi viết. Chúng cho phép duy trì hồ sơ tham chiếu sau nếu khó hiểu mã sau này.
Bạn sẵn sàng thử thách? Viết block comment đầu một chương trình. Chú thích bao gồm:
- Tên bạn
- Khi tạo tệp
- Tên tệp
- Mục đích tệp
Thử chạy mã. Nếu chương trình không chạy vì chú thích, bạn lỡ. Nếu chạy bình thường, chúc mừng! Bạn viết chú thích thành công.
Trong hướng dẫn này, khám phá cách viết chú thích, chú thích cùng dòng, block comments Python. Cũng thảo luận cách nhà phát triển viết chú thích cho kiểm thử. Bây giờ bạn viết chú thích như chuyên gia Python!
Muốn thành thạo Python? Về hỗ trợ khóa học, sách, tài nguyên học Python hàng đầu, xem hướng dẫn toàn diện How to Learn Python.