Viết comments trong Python

Khi viết mã bằng Python cần đặt tên rõ ràng cho các biến, xác định hàm rõ ràng và sắp xếp mã của bạn đều là những điều cần làm để người khác có thể dễ dàng đọc và hiểu được mã của bạn.

Trong bài viết này, Bumbii sẽ trình bày một số kiến thức cơ bản về viết chú thích/giải thích bằng Python, nhưng để ngắn gọn thì trong bài viết này chúng ta sẽ dùng từ comment. Bạn sẽ học cách viết comment rõ ràng và xúc tích.

Tham gia cộn g đồng học tập Bumbii trên Discord

Chia sẻ, hỏi đáp, bàn luận các vấn đề học tập.
Gặp gỡ các anh chị, thầy cô có nhiều năm kinh nghiệm.
Cập nhật các kiến thức, tài liệu mới nhất.

Tham gia ngay!

Giới thiệu về comment trong Python

Đôi khi, bạn muốn chú thích lại mã mà bạn viết. Ví dụ: bạn có thể muốn lưu ý lý do tại sao một đoạn mã hoạt động. Để làm điều đó, bạn sử dụng các comment.

Thông thường, bạn sử dụng comment để giải thích các công thức, thuật toán và logic phức tạp.

Việc viết comment giúp cho người đọc code có thể dễ dàng hiểu được logic mà không cần phải mất nhiều thời gian.

Cách viết comment trong Python

Comment cơ bản

Các nhà phát triển chú thích các phần của mã khi cần thiết để tạo điều kiện cho các lập trình viên, bao gồm cả chính bạn hiểu về mã một cách nhanh nhất.

Để viết comment bằng Python, chỉ cần đặt dấu thăng # trước comment bạn muốn:

# You can add a comment

Python bỏ qua mọi thứ sau dấu # và cho đến cuối dòng code. Bạn có thể chèn chúng vào bất kỳ đâu trong mã của mình, thậm chí ngay cả trong dòng với mã khác:

print("This is code available") # This won't run

Khi chạy đoạn mã trên, bạn sẽ chỉ thấy kết quả This will run. Mọi thứ khác đều bị bỏ qua.

Comment phải ngắn gọn, dễ hiểu và mô tả được logic.

Comment nhiều dòng trong Python

Python không có cách viết comment nhiều dòng như bạn có thể làm bằng các ngôn ngữ như C, Java và Go.

# You can't
add multiple line comments
in python

Trong ví dụ trên, dòng đầu tiên sẽ bị chương trình bỏ qua, nhưng các dòng khác sẽ gây ra lỗi cú pháp.

Ngược lại, một ngôn ngữ như Java sẽ cho phép bạn dàn trải một comment trên nhiều dòng khá dễ dàng:

/*  You can
add multiple line comments
in Java */

Mọi thứ giữa /* và */ đều bị chương trình bỏ qua.

Có 2 cách để viết comment nhiều dòng trong Python

Cách đầu tiên chỉ đơn giản là thêm dấu # trước tất cả các dòng bạn muốn comment:

def multiline_example():
    # This is the first comment
    # This is the second comment
    # This is the third comment

Mỗi dòng bắt đầu bằng dấu # sẽ bị chương trình bỏ qua.

Cách thứ hai là sử dụng chuỗi nhiều dòng bằng cách gói comment của bạn bên trong một bộ ba dấu ngoặc kép:

"""
This is the second way to comment multiple lines of code in Python.
"""

Điều này giống như các comment nhiều dòng trong Java, trong đó mọi thứ nằm trong dấu ngoặc kép sẽ hoạt động như một comment.

Phím tắt để viết comment nhiều dòng: Ctrl+/ on PC, or Cmd+/ on Mac.

Làm thế nào để viết comment tối ưu nhất?

Điều quan trọng nhất khi viết comment là đảm bảo rằng comment của bạn dễ đọc và dễ hiểu.

Khi viết mã cho chính mình:

Nếu bạn không chắc chương trình của mình sẽ chạy theo logic như thế nào thì bạn có thể sử dụng comment như một cách để theo dõi những việc còn lại phải làm hoặc thậm chí là một cách để biết được logic hiện hữu mà chương trình đang chạy. Ví dụ:

from collections import defaultdict

def get_top_cities(prices):
    top_cities = defaultdict(int)

    # For each price range
        # Get city searches in that price
        # Count num times city was searched
        # Take top 3 cities & add to dict

    return dict(top_cities)

Sử dụng comment để xác định các phần phức tạp trong mã của riêng bạn. Nếu bạn hoàn thành một dự án và quay lại với nó nhiều tháng hoặc nhiều năm sau đó, bạn sẽ mất rất nhiều thời gian để làm quen và hiểu với những gì bạn đã viết. Comment sẽ giúp bạn tiếp cận dự án một cách nhanh nhất.

Khi viết mã cho người khác

Thông thường bạn chỉ đọc lướt code. Trừ khi xảy ra lỗi hoặc dự án không hoạt động bạn mới đọc từng dòng code để kiểm tra lỗi.

Trong hầu hết các trường hợp khác, bạn sẽ xem nhanh các biến và định nghĩa hàm để hiểu ý chính. Việc có những comments để giải thích những gì đang hoạt động sẽ hỗ trợ nhà phát triển ở trường hợp này.

Nếu bạn có một phương thức hoặc hàm phức tạp mà tên của nó không dễ hiểu, bạn có thể thêm một comment ngắn sau dòng def để giải thích:

def complicated_function(s):
# This function does something complicated

Điều này có thể giúp các nhà phát triển khác đang đọc mã của bạn hiểu được chức năng của hàm này.

Tổng kết:

Biết cách viết comment bằng Python có thể giúp cho việc đọc và hiểu mã của tất cả các nhà phát triển, bao gồm cả chính bạn trở nên dễ dàng hơn! Giúp các nhà phát triển khác đọc, hiểu và phát triển mã của bạn một cách nhanh nhất và giúp bạn làm quen lại với mã cũ của bạn mà không phải mất nhiều thời gian.

Chúc các bạn học tốt!