Comments trong Python

1. Comments là gì? (Giải thích bằng tiếng Việt)

Comment là những dòng chú thích trong mã nguồn, được viết ra để:

  • Giải thích logic, ý tưởng, hoặc mục đích của đoạn code.
  • Nhắc nhở chính bản thân lập trình viên khi xem lại code sau một thời gian.
  • Giúp đồng đội hiểu suy nghĩ và mục đích của bạn.
  • Lưu lại các đoạn code tạm thời không muốn xoá nhưng cũng không muốn chạy.

Python sẽ bỏ qua hoàn toàn comment khi chạy chương trình.

2. Comment đơn trong Python – dùng ký tự #

Cách viết:

# Đây là một comment trong Python

Ví dụ giải thích logic:

number = 10

# Kiểm tra số dương trước khi thực hiện phép chuyển đổi
if number > 0:
    print("Số này là số dương.")

Giải thích (VN):

  • Dòng bắt đầu bằng # sẽ không được thực thi.
  • Lập trình viên dùng comment để mô tả vai trò của logic phía dưới.

3. Comment giúp đồng đội hiểu code

Ví dụ minh họa:

def tinh_tong_va_nhan(x, y):
    # Trả về tổng và tích của hai số để phục vụ phần tính toán trong chương trình chính
    tong = x + y
    tich = x * y
    return tong, tich

Trong môi trường làm việc nhóm, các comment như vậy giúp người khác nắm rõ mục đích hàm.

4. “Comment out” – Tạm thời vô hiệu hóa code

Đôi khi bạn không muốn chạy một đoạn code nhưng cũng không muốn xoá nó.

Ví dụ:

# print("Dòng code này tạm thời bị vô hiệu hoá.")

Hoặc bạn muốn thử phiên bản mới và giữ lại phiên bản cũ:

# version cũ:
# result = tinh_tong_va_nhan(3, 4)

# version mới:
result = (3 + 4, 3 * 4)

5. Comment khối bằng dấu ''' ... ''' hoặc """ ... """

Dùng khi:

  • Bạn muốn viết một đoạn mô tả dài.
  • Bạn muốn "comment out" nhiều dòng cùng lúc.

Ví dụ:

'''
Đoạn code dưới đây thực hiện việc chuyển đổi
từ số nguyên sang dạng nhị phân.
Hiện tại đang tạm thời vô hiệu hoá để thử logic mới.
'''

# old_code = bin(10)
# print(old_code)

Dù về mặt kỹ thuật đây là một chuỗi (string), nếu không gán cho biến nào, Python sẽ bỏ qua.

6. Lạm dụng comment: Không nên

Không phải lúc nào cũng cần comment.

Quá nhiều comment sẽ khiến code rối và khó đọc.

Nguyên tắc vàng:

  • Code rõ ràng → comment ít.
  • Code phức tạp → comment để giải thích lý do, không phải giải thích từng dòng.

7. Ví dụ tổng hợp – Chuyển đổi số nguyên sang nhị phân với comment đúng chuẩn

Code mẫu:

def chuyen_doi_nhi_phan(n):
    # Hàm chỉ xử lý số nguyên dương
    if n < 0:
        return "Vui lòng nhập số nguyên dương."

    # Khởi tạo kết quả
    ket_qua = ""

    # Lặp tới khi n = 0
    while n > 0:
        du = n % 2        # Lấy phần dư (bit cuối)
        ket_qua = str(du) + ket_qua  # Thêm bit vào kết quả
        n = n // 2        # Chia n cho 2 để tiếp tục

    return ket_qua


# Ví dụ sử dụng
print(chuyen_doi_nhi_phan(10))  # Kết quả: 1010

8. Bài tập tự luyện

  1. Hãy viết một hàm kiểm tra số chẵn lẻ và thêm comment hợp lý mô tả logic bên trong.
  1. Viết 5 dòng code bất kỳ rồi "comment out" 2 dòng bạn không muốn chạy.
  1. Viết một đoạn mô tả 4–5 dòng bằng comment khối giải thích mục đích chương trình bạn đang viết.