Dấu thăng # không nằm trong chuỗi literal bắt đầu một comment. Tất cả ký tự sau # đến hết dòng vật lý là comment và bị trình thông dịch bỏ qua.
Các loại comment
Comment một dòng
#!/usr/bin/python
# First comment
print("Hello, Python!") # second comment - comment cuối dòng
Comment nhiều dòng (dùng # mỗi dòng)
# This is a comment. # This is a comment, too. # This is a comment, too. # I said that already.
Comment nhiều dòng (dùng triple-quoted string)
''' Đây là comment nhiều dòng. Có thể viết nhiều dòng text. Thường dùng làm docstring cho module/hàm/class. ''' """ Cũng là comment nhiều dòng. Dùng cho docstring theo PEP 257. """
Docstring - Chuỗi tài liệu
Triple-quoted string ngay sau định nghĩa module/hàm/class là docstring, truy xuất bằng __doc__ hoặc help():
def tinh_tong(a, b):
"""Tính tổng hai số.
Args:
a: số thứ nhất
b: số thứ hai
Returns:
Tổng a + b
"""
return a + b
print(tinh_tong.__doc__)
help(tinh_tong)
Best Practices
- Comment tại sao (why), không phải cái gì (what) - code tự giải thích cái gì
- Giữ comment đồng bộ khi sửa code
- Dùng docstring cho API công khai
- Tránh comment code chết - hãy xóa nó