Cách ghi chú (comment) một khối mã trong Python

Chú thích (comments) là một trong những công cụ hữu ích nhất khi làm việc với Python. Chúng dẫn dắt chúng ta qua logic, quyết định và mục đích đằng sau các khối mã mà không can thiệp vào quá trình thực thi. Chú thích giúp mã dễ đọc, dễ bảo trì hơn và tạo điều kiện hợp tác trong môi trường làm việc nhóm.

Hướng dẫn này sẽ đi sâu vào hai phương pháp hiệu quả để ghi chú nhiều dòng mã trong Python, giúp mã của bạn được ghi chép đầy đủ và dễ hiểu.

Vì sao chú thích khối (block comments) trong Python lại quan trọng?

Chú thích thường là một trong những khái niệm đầu tiên bạn gặp trên hành trình học Python. Chúng cung cấp ngữ cảnh hữu ích về ý định đằng sau một đoạn mã nhất định, mang lại sự rõ ràng về lý do một script hoạt động như vậy. Có nhiều lý do quan trọng khiến bạn luôn nên dùng chú thích trong script của mình. Dưới đây là bốn lý do:

• Tài liệu hóa: Chú thích đóng vai trò như tài liệu giải thích mục đích của hàm, lớp hoặc các khối mã. Điều này đặc biệt hữu ích với các thuật toán phức tạp mà logic không dễ hiểu ngay.
• Dễ đọc: Mã được chú thích tốt sẽ dễ đọc và dễ hiểu hơn. Điều này rất quan trọng khi bạn hoặc người khác quay lại mã sau một thời gian.
• Gỡ lỗi: Tạm thời chú thích các phần mã là một thực tiễn phổ biến để cô lập và xác định lỗi.
• Hợp tác: Trong môi trường làm việc nhóm, chú thích giúp mã dễ chia sẻ và dễ hiểu hơn, tạo điều kiện thuận lợi cho việc cộng tác và review mã.

Sử dụng chú thích khối bằng một dòng trong Python

Trước khi đi vào ghi chú nhiều dòng, hãy bắt đầu với những điều cơ bản về chú thích một dòng. Trong Python, chú thích một dòng bắt đầu bằng ký hiệu thăng (#), và trình thông dịch Python sẽ bỏ qua mọi thứ theo sau nó trên cùng một dòng. Để tạo chú thích một dòng, hãy làm theo hướng dẫn dưới đây:

1. Vị trí: Đặt ký hiệu # ở đầu dòng hoặc sau đoạn mã trên cùng một dòng. Chú thích có thể đặt phía trên đoạn mã mà chúng mô tả, ở cuối cùng dòng mã đó, hoặc đứng riêng một dòng.
2. Nội dung: Sau ký hiệu #, viết chú thích của bạn. Đó có thể là lời giải thích cho dòng mã, ghi chú để tham khảo sau này, hoặc bất kỳ thông tin hữu ích nào liên quan đến mã.

# This is a single-line comment explaining the next line of code
print("Hello, world!")  # This prints a message to the console

Phương pháp #1: Ghi chú bằng nhiều dấu # cho từng dòng

Cách đơn giản nhất để ghi chú trong Python là dùng ký hiệu #, ký hiệu này sẽ chú thích mọi thứ theo sau nó trên dòng đó. Mặc dù Python không có cú pháp riêng cho chú thích khối, bạn có thể dùng nhiều ký hiệu # để chú thích từng dòng một. Bạn chỉ cần thực hiện các bước sau:

1. Xác định khối mã: Trước tiên, xác định khối mã bạn muốn chú thích. Đó có thể là một hàm, một vòng lặp, hoặc bất kỳ phần nào của mã mà bạn muốn vô hiệu hóa hoặc giải thích.
2. Chú thích từng dòng: Đặt một ký hiệu # ở đầu mỗi dòng bạn muốn chú thích. Điều này báo cho trình thông dịch Python bỏ qua các dòng đó khi thực thi.

Bạn có thể xem ví dụ dưới đây:

# Example of commenting out multiple lines individually 
# print("Hello, world")
# print("What are you up to?")

print("Just floating in space. What was the question?")

Phương pháp chú thích khối Python #2: Ghi chú bằng chuỗi nhiều dòng (triple-quoted string)

Một phương pháp thay thế để chú thích nhiều dòng là dùng chuỗi nhiều dòng (''' ''' hoặc """ """). Dù không phải là chú thích khối chính thức, các chuỗi này thường được dùng theo cách đó, đặc biệt cho chú thích nhiều dòng hoặc docstring. Để dùng chuỗi ba dấu nháy, chỉ cần đặt ''' hoặc """ trước và sau khối mã bạn muốn chú thích, như sau:

'''
def example_function(name):
	print("Hello", name)
'''

Chuỗi nhiều dòng thường được dùng nhất để ghi chú cho các hàm Python. Ví dụ:

# Create hello() function
def hello(name):
	'''
	This function takes as input a name, 
	and returns a salutation to the name in the form of "Hello name"
	'''
	# Print the output 
	print("Hello", name)

hello("John")

Các chuỗi ba dấu nháy này được gọi là docstring — bạn có thể đọc thêm về chúng trong hướng dẫn về docstring của chúng tôi.