Ghi chú trong code

5.1 Cách viết ghi chú

Trong Python, cũng giống như nhiều ngôn ngữ lập trình khác, bạn có thể viết ghi chú trong mã. Ghi chú giúp các lập trình viên và những người tham gia dự án khác hiểu mã dễ hơn, điều này đặc biệt hữu ích khi làm việc nhóm và bảo trì chương trình trong thời gian dài. Trong Python có vài cách để thêm ghi chú vào mã.

Ghi chú một dòng:

Bắt đầu với ký tự #. Tất cả những gì theo sau # trong cùng một dòng, Python sẽ bỏ qua. Loại ghi chú này thường được sử dụng cho những nhận xét ngắn hoặc giải thích một dòng mã cụ thể. Ví dụ:

# Đây là ghi chú một dòng
print("Hello, World!") # Giải thích cho hành động của hàm

Ghi chú nhiều dòng:

Trong Python không có cú pháp đặc biệt cho ghi chú nhiều dòng, nhưng bạn có thể tạo chúng bằng cách sử dụng nhiều ghi chú một dòng hoặc sử dụng dấu ngoặc ba, mặc dù cái sau thực sự là một literal chuỗi nhiều dòng, không thực hiện như mã. Ví dụ:

# Đây là ví dụ về ghi chú nhiều dòng # Mỗi dòng bắt đầu với ký tự #
      

hoặc:

""" Đây là một literal chuỗi nhiều dòng mà có thể được sử dụng như là ghi chú. Python hiểu nó như một chuỗi, nhưng không làm gì với chuỗi này, nếu nó không được gán cho biến hoặc sử dụng trong một biểu thức. """ 
      

5.2 Tại sao viết ghi chú

Sử dụng ghi chú trong mã giúp tăng cường khả năng đọc, dễ dàng duy trì và cập nhật, cũng như thăng tiến sự hợp tác hiệu quả hơn trong các nhóm. Ghi chú nên ngắn gọn, nhưng thông tin và luôn cập nhật, để làm tài liệu hữu ích cho mã mà không làm ô nhiễm nó với thông tin không cần thiết.

Dòng tài liệu (docstrings):

Đây là những dòng thường đặt ở đầu của module, class, method và function để mô tả mục đích của chúng. Chúng được đặt trong dấu ngoặc ba và có thể được sử dụng để tự động tạo tài liệu.

Ví dụ:

def add(a, b):
""" Hàm để cộng hai số lại. :param a: số hạng thứ nhất :param b: số hạng thứ hai :return: tổng của a và b """
    return a + b

Trong thế giới lập trình đôi khi các nhà phát triển thêm vào mã của họ những ghi chú không chỉ để giải thích mà còn để gây cười. Đây là một vài ví dụ về những ghi chú hài hước mà bạn có thể gặp trong mã:

Ví dụ 1

 

            # Tôi có thể giải thích đây là cái gì, nhưng thậm chí bây giờ tôi cũng không rõ.
        

Ví dụ 2

 

    # Nếu không hoạt động, thì đó là lỗi của ai khác.

Ví dụ 3

 

    # Đến, nhìn thấy, sửa... và phá hỏng.

Ví dụ 4

 

    # Khi tôi viết cái này, chỉ tôi và Chúa biết nó hoạt động như thế nào. 
    # Giờ thì chỉ còn Chúa biết.

Những ghi chú này có thể mang lại sự nhẹ nhàng và hài hước trong quá trình phát triển, làm cho cơ sở mã ít đơn điệu hơn. Chúng cũng có thể là những lời nhắc nhở rằng phát triển phần mềm là một quá trình sáng tạo và đầy tính nhân văn.

5.3 Nhanh chóng ghi chú mã

Trong PyCharm bạn có thể nhanh chóng ghi chú hoặc bỏ ghi chú mã bằng cách sử dụng phím tắt. Để làm điều này, hãy chọn các dòng mã mà bạn muốn thay đổi, và nhấn Ctrl + / trên Windows (hoặc Cmd + / trên macOS). Tổ hợp phím này sẽ thêm hoặc xóa ký tự ghi chú trên mỗi dòng đã chọn, làm cho quá trình nhanh chóng và hiệu quả.