1. Cách viết nhận xét
Trong Python, giống như nhiều ngôn ngữ lập trình khác, bạn có thể viết nhận xét trong mã.
Nhận xét — đây chỉ là văn bản dành cho các lập trình viên khác: Python interpreter không phản ứng hay thực thi mã ghi trong đó. Nhận xét giúp lập trình viên và các thành viên dự án khác hiểu mã, điều này đặc biệt hữu ích khi làm việc nhóm và bảo trì lâu dài phần mềm. Trong Python có nhiều cách để thêm nhận xét vào mã.
Nhận xét một dòng:
Bắt đầu bằng ký tự #. Tất cả những gì sau # trên cùng một dòng sẽ bị Python interpreter bỏ qua. Loại nhận xét này thường được sử dụng để ghi chú ngắn gọn hoặc giải thích cho một dòng mã nhất định. Ví dụ:
# Đây là một nhận xét một dòng
print("Hello, World!") # Giải thích hành động của hàm
Nhận xét nhiều dòng:
Trong Python, không có cú pháp chính thức cho việc viết nhận xét nhiều dòng, nhưng bạn có thể tạo chúng bằng nhiều nhận xét một dòng hoặc sử dụng dấu ngoặc kép ba, mặc dù điều thứ hai thực sự là một literal chuỗi nhiều dòng và nó không được thực thi như mã. Ví dụ:
# Đây là một ví dụ về nhận xét nhiều dòng
# Mỗi dòng bắt đầu bằng ký tự `#`
hoặc:
""" Đây là một literal chuỗi nhiều dòng, có thể sử dụng như một nhận xét. Python coi nó như một chuỗi, nhưng không làm gì với chuỗi này nếu nó không được gán cho một biến hoặc không được sử dụng trong biểu thức. """
Rất hữu ích! Literal — là một phần nhỏ dữ liệu được ghi trực tiếp trong mã: số, chuỗi và các loại tương tự.
2. Tại sao phải viết nhận xét
Việc sử dụng nhận xét trong mã làm tăng khả năng đọc, dễ bảo trì và cập nhật, cũng như giúp hợp tác nhóm hiệu quả hơn. Nhận xét nên ngắn gọn nhưng thông tin và phù hợp để đóng vai trò là tài liệu hữu ích cho mã và không làm rối loạn mã với thông tin không cần thiết.
Dòng tài liệu (docstrings):
Đây là các chuỗi nhiều dòng thường được đặt ở đầu của các module, class, method và function để mô tả mục đích của chúng. Chúng được đặt trong ba cặp dấu ngoặc kép và được sử dụng để tự động tạo tài liệu.
Ví dụ:
def add(a, b): """ Hàm để cộng hai số. :param a: số hạng đầu tiên :param b: số hạng thứ hai :return: tổng của a và b """ return a + b
Trong thế giới lập trình, các nhà phát triển đôi khi thêm các nhận xét vào mã của họ không chỉ để giải thích mà còn để mang lại nụ cười. Sau đây là một số ví dụ nhận xét hài hước bạn có thể gặp trong mã:
Ví dụ 1:
# Tôi có thể giải thích điều gì đang xảy ra ở đây, nhưng ngay cả tôi cũng không còn hiểu được nữa.
Ví dụ 2:
# Nếu cái này không chạy, lỗi chắc chắn là do người khác.
Ví dụ 3:
# Đến, thấy, sửa... và phá!
Ví dụ 4:
# Khi tôi viết điều này, chỉ có tôi và Chúa mới biết nó hoạt động thế nào.
# Bây giờ chỉ còn Chúa biết.
Ví dụ 5:
# Số giờ lãng phí vào đây = 42.
Những nhận xét này có thể mang lại sự nhẹ nhàng và hài hước vào quá trình phát triển, giúp bộ mã bớt nhàm chán. Chúng cũng nhắc nhở rằng phát triển phần mềm là một quá trình sáng tạo và đầy tính nhân văn.
5.3 Nhanh chóng nhận xét mã
Trong PyCharm IDE, bạn có thể nhanh chóng nhận xét hoặc huỷ nhận xét mã bằng cách sử dụng các phím tắt. Để làm điều này, hãy chọn các dòng mã mà bạn muốn nhận xét hoặc huỷ nhận xét, và nhấn Ctrl + / trên Windows (hoặc Cmd + / trên macOS). Phím tắt này thêm hoặc xóa ký tự nhận xét vào từng dòng được chọn, làm cho quá trình trở nên nhanh chóng và hiệu quả.
GO TO FULL VERSION