Chú thích

Chú thích hoặc chú giải được thêm vào với mục đích làm cho mã nguồn dễ hiểu hơn đối với con người và bị bỏ qua bởi trình thông dịch Python. Những chú thích này cải thiện tính đọc được của mã và giúp cho các lập trình viên hiểu mã tốt hơn.

Giống như hầu hết các ngôn ngữ hiện đại, Python hỗ trợ chú thích trên một dòng (hoặc cuối dòng) và nhiều dòng (khối). Chú thích Python rất giống với các chú thích có sẵn trong các ngôn ngữ lập trình PHP, BASH và Perl.

Có ba loại chú thích có sẵn trong Python:

• Chú thích trên một dòng
• Chú thích nhiều dòng
• Chú thích Docstring.

Chú thích trên một dòng

Dấu thăng # không nằm trong một chuỗi bắt đầu một chú thích. Tất cả các ký tự sau dấu thăng # và cho đến cuối dòng được xem là phần của chú thích và trình thông dịch Python bỏ qua chúng.

Ví dụ

Dưới đây là một ví dụ về chú thích trên một dòng trong Python:

# This is a single line comment in python
print ("Hello, World!")

Bạn có thể nhập một chú thích trên cùng một dòng sau một câu lệnh hoặc biểu thức

name = "Madisetti" # Đây lại là chú thích

Chú thích nhiều dòng

Python không cung cấp một cách trực tiếp để chú thích nhiều dòng. Bạn có thể chú thích nhiều dòng như sau:

# This is a comment.
# This is a comment, too.
# This is a comment, too.
# I said that already.

Chuỗi có ba dấu nháy cùng lúc được bỏ qua bởi trình thông dịch Python và có thể được sử dụng như là một chú thích nhiều dòng:

'''
Đây là một chú thích nhiều
dòng.
'''

Chú thích Docstring

Docstring Python cung cấp một cách tiện lợi để cung cấp tài liệu trợ giúp cho các module Python, hàm, lớp và phương thức. Docstring được làm sẵn thông qua thuộc tính __doc__.

def add(a, b):
    """Function to add the value of a and b"""
    return a+b

print(add.__doc__)

Điều này cho ra kết quả sau:

Function to add the value of a and b