Chú thích khối
Bài học 6 trên 28 trong khóa học Clean Code: viết code tốt hơn với Python của Coddy.
“Nếu cách triển khai khó giải thích, thì đó là một ý tưởng tồi.”
- The Zen of Python
Chú thích rất quan trọng để bất kỳ ai đọc code của bạn cũng có thể hiểu được.
Chú thích trong Python được chia thành 3 loại:
- Chú thích khối
- Chú thích nội tuyến
- Chuỗi tài liệu
Hãy bắt đầu với chú thích khối:
- Bắt đầu ở cùng mức thụt lề với khối lệnh mà chúng mô tả.
- Bắt đầu mỗi dòng bằng
#, theo sau là một dấu cách.
Ví dụ:
while i < 10:
# Lặp với i cho đến khi i < 10
# In i ra trên dòng mới rồi tăng i thêm 1
print(i, '\n')
i += 1Thử thách
DễBạn có hàm greet; hãy viết chú thích dạng khối (block comment) để mô tả hàm này làm gì, bằng lời của bạn.
Làm theo các quy tắc!
Tự làm thử
def greet(name):
print('Hello', name)Tất cả bài học trong Clean Code: viết code tốt hơn với Python
Tự luyện tập: Trình biên dịch Python online