Chú thích cùng dòng
Bài học 7 trên 28 trong khóa học Clean Code: viết code tốt hơn với Python của Coddy.
Chú thích trên cùng dòng giải thích một câu lệnh (statement) trong đoạn code.
- Viết chú thích trên cùng dòng với câu lệnh mà chúng nói đến.
- Cách chú thích trên cùng dòng ít nhất hai khoảng trắng với câu lệnh.
- Bắt đầu bằng
#và một khoảng trắng. - Đừng dùng chúng để giải thích những điều hiển nhiên.
Ví dụ:
result = check(name) # Kiểm tra xem name có hợp lệ khôngPhần lớn thời gian, bạn sẽ ưu tiên dùng các khối chú thích thay vì chú thích trên cùng dòng.
Thử thách
DễBạn được cho một đoạn code nhỏ thực hiện phép tính đơn giản để tăng salary. Hãy viết chú thích (comment) trên cùng dòng để giải thích câu lệnh này.
Đây có lẽ là lời giải thích hiển nhiên, nhưng để luyện tập, mình sẽ làm điều này...
Tự làm thử
salary = 1000
salary = salary * 1.05Tấ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