Hướng dẫn how do you write comments in python how do you comment multiple lines in python? - Làm thế nào để bạn viết bình luận trong python làm thế nào để bạn bình luận nhiều dòng trong python?

Để lại nhận xét mã đôi khi có thể giúp làm rõ mã của bạn.

Có 3 loại bình luận không chính thức trong Python.

Một bình luận khối "

# Multiply savings by the annual interest rate
savings = savings * 1.02

Một bình luận trực tuyến "

savings = savings * 1.02 # Multiply savings by the annual interest rate

Một bình luận đa dòng của người Viking đã lạm dụng một tài liệu:

'''
This here
is a longer
multi-line comment
also known as docstring.
'''
print("Yay")

Mã nhận xét trong Python

Để thêm nhận xét trong Python, hãy sử dụng toán tử hashtag # trước khi bắt đầu nhập nhận xét.

Trước khi đào sâu vào các chi tiết, hãy nhớ rằng mã nhận xét thường là xấu. Bạn nên luôn cố gắng viết mã thể hiện đủ rõ ràng để không cần bình luận.

Hãy cùng xem một ví dụ về đoạn mã này. Nó thực hiện cuộc đi bộ ngẫu nhiên 1D. Như bạn có thể thấy, mã được xử lý với các bình luận giải thích các dòng dưới đây.

import numpy as np
import random

def randwlk1d(n):
    x, y = 0, 0
    # Generate the time points (tps) [1, 2, 3, ... , n]
    tps = np.arange(n + 1)
    
    # Initialize positions array ps to the starting point y
    ps = [y]
    
    # Specify directions up and down (U and D)
    ds = ["U", "D"]
    for i in range(1, n + 1):
        # Randomly select either U or D (up or down)
        s = random.choice(ds)
        
        # Move the object up (U) or down (D)
        if s == "U":
            y += 1
        elif s == "D":
            y -= 1
        # Add each position to the ps list to track the positions
        ps.append(y)
        
    # Return timepoints and positions as (tps, ps)
    return tps, ps

Nhưng điều gì sẽ xảy ra nếu thay vì bình luận về mã, chúng ta chỉ sử dụng tên biến dễ hiểu hơn?

import numpy as np
import random

def randomwalk1D(n):
    x, y = 0, 0
    timepoints = np.arange(n + 1)
    positions = [y]
    directions = ["UP", "DOWN"]
    
    for i in range(1, n + 1):
        step = random.choice(directions)
        
        if step == "UP":
            y += 1
        elif step == "DOWN":
            y -= 1
            
        positions.append(y)
        
    return timepoints, positions

Như bạn có thể thấy, điều này cải thiện chất lượng mã bằng một tấn. Không cần phải sử dụng nhận xét nữa khi mã nói về chính nó.

Tuy nhiên, đôi khi nó có thể hữu ích để có thể nhận xét mã. Vì vậy, hãy để Lừa xem những loại bình luận nào có trong Python.

Các loại nhận xét khác nhau trong Python

Trong Python, ý kiến ​​bắt đầu với

savings = savings * 1.02 # Multiply savings by the annual interest rate

Nhưng có ba cách thường được sử dụng để thêm nhận xét trong Python:

1. Một dòng trước mã.
2. Ở cuối dòng mã trên cùng một dòng.
3. Trên nhiều dòng sử dụng dấu vết ba lần.

   Dưới đây là tên không chính thức của ba loại bình luận này:

1. Khối ý kiến
2. Ý kiến ​​nội tuyến
3. Nhận xét đa dòng hoặc tài liệu.

Hãy cùng xem một loại bình luận gần hơn.

1. Khối ý kiến ​​trong Python

Nhận xét khối giải thích mã sau. Loại bình luận này thường được đặt một dòng trước đoạn mã mà nó thể hiện. Một bình luận khối thường được thụt vào cùng cấp với mã trong dòng tiếp theo.

Ví dụ:

# Multiply savings by the annual interest rate
savings = savings * 1.02

2. Nhận xét nội tuyến trong Python

Một nhận xét nội tuyến là một nhận xét về cùng một dòng với mã. Mặc dù điều này chính thức phân loại là một nhận xét như bất kỳ ai khác, đôi khi bạn có thể nghe các nhà phát triển gọi nó là một nhận xét nội tuyến.

Ví dụ:

savings = savings * 1.02 # Multiply savings by the annual interest rate

3. Nhận xét đa dòng trong Python

Chuỗi tài liệu hoặc một docString là một chuỗi được tạo bằng ba trích dẫn

savings = savings * 1.02 # Multiply savings by the annual interest rate

Nhưng điều này thực sự không có nghĩa là được sử dụng như một bình luận. Thay vào đó, nó được sử dụng như một chuỗi tài liệu. Trong Python, có một trợ giúp chức năng tích hợp () bạn có thể gọi trên bất kỳ đối tượng Python nào. Nếu đối tượng đó chỉ định một tài liệu, hàm trợ giúp () cho thấy trong bảng điều khiển. Điều này có thể giúp bạn tiết kiệm thời gian để lặn vào tài liệu.help() you can call on any Python object. If that object specifies a docstring, the help() function shows that in the console. This can save you time from diving into the docs.

Ví dụ:

def greet(name):
    """ Greets a person with their name. """
    print(f"Hello, {name}")

2. Nhận xét nội tuyến trong Pythonhelp() on the greet() method anywhere where it is accessible:

help(greet)

Output:

Help on function greet in module __main__:

greet(name)
    Greets a person with their name.

Một nhận xét nội tuyến là một nhận xét về cùng một dòng với mã. Mặc dù điều này chính thức phân loại là một nhận xét như bất kỳ ai khác, đôi khi bạn có thể nghe các nhà phát triển gọi nó là một nhận xét nội tuyến.not ignored by the Python interpreter because of the help() function. Thus a docstring cannot be classified as a code comment. However, you could use it to comment code without problems. But this is against best practices. Read more about docstrings and their purpose in Python.

Ví dụ:

3. Nhận xét đa dòng trong Python

Chuỗi tài liệu hoặc một docString là một chuỗi được tạo bằng ba trích dẫn

savings = savings * 1.02 # Multiply savings by the annual interest rate

Nhưng điều này thực sự không có nghĩa là được sử dụng như một bình luận. Thay vào đó, nó được sử dụng như một chuỗi tài liệu. Trong Python, có một trợ giúp chức năng tích hợp () bạn có thể gọi trên bất kỳ đối tượng Python nào. Nếu đối tượng đó chỉ định một tài liệu, hàm trợ giúp () cho thấy trong bảng điều khiển. Điều này có thể giúp bạn tiết kiệm thời gian để lặn vào tài liệu.

Bây giờ bạn có thể gọi trợ giúp () trên phương thức Greet () ở bất cứ đâu có thể truy cập được:

Dưới mui xe, một DocString là một chuỗi theo nghĩa đen không bị thông dịch viên Python bỏ qua vì hàm trợ giúp (). Do đó, một tài liệu không thể được phân loại là một nhận xét mã. Tuy nhiên, bạn có thể sử dụng nó để nhận xét mã mà không gặp vấn đề gì. Nhưng điều này là chống lại các thực tiễn tốt nhất. Đọc thêm về Docstrings và mục đích của họ trong Python.

Sự kết luận