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