Hướng dẫn how do you comment a line in python? - làm thế nào để bạn nhận xét một dòng trong python?

Giới thiệu

Nhận xét là những dòng tồn tại trong các chương trình máy tính bị bỏ qua bởi các trình biên dịch và phiên dịch viên. Sử dụng nhận xét trong các chương trình có thể làm cho mã dễ đọc hơn cho con người, vì nó cung cấp một số thông tin hoặc giải thích về những gì mỗi phần của chương trình đang làm.

Tùy thuộc vào mục đích của chương trình của bạn, nhận xét có thể đóng vai trò là ghi chú cho chính bạn hoặc nhắc nhở hoặc chúng có thể được viết với mục đích của các lập trình viên khác có thể hiểu mã của bạn đang làm gì.

Nói chung, bạn nên viết bình luận trong khi bạn đang viết hoặc cập nhật một chương trình vì thật dễ dàng để quên quá trình suy nghĩ của bạn sau này và các bình luận được viết sau đó có thể ít hữu ích hơn trong dài hạn.

Điều kiện tiên quyết

Bạn nên cài đặt Python 3 và môi trường lập trình được thiết lập trên máy tính hoặc máy chủ của bạn. Nếu bạn không có môi trường lập trình được thiết lập, bạn có thể tham khảo hướng dẫn cài đặt và thiết lập cho môi trường lập trình cục bộ hoặc cho môi trường lập trình trên máy chủ của bạn phù hợp với hệ điều hành của bạn (Ubuntu, Centos, Debian, v.v.)

Nhận xét trong Python bắt đầu bằng dấu băm (#) và ký tự khoảng trắng và tiếp tục đến cuối dòng.

Thông tin: Để làm theo cùng với mã ví dụ trong hướng dẫn này, hãy mở một vỏ tương tác Python trên hệ thống cục bộ của bạn bằng cách chạy lệnh

# Print “Hello, World!” to console
print("Hello, World!")
0. Sau đó, bạn có thể sao chép, dán hoặc chỉnh sửa các ví dụ bằng cách thêm chúng sau lời nhắc
# Print “Hello, World!” to console
print("Hello, World!")
1.
To follow along with the example code in this tutorial, open a Python interactive shell on your local system by running the
# Print “Hello, World!” to console
print("Hello, World!")
0 command. Then you can copy, paste, or edit the examples by adding them after the
# Print “Hello, World!” to console
print("Hello, World!")
1 prompt.

Nói chung, nhận xét sẽ trông giống như thế này:

# This is a comment

Bởi vì nhận xét không thực thi, khi bạn chạy một chương trình, bạn sẽ không thấy bất kỳ dấu hiệu nào của nhận xét ở đó. Nhận xét nằm trong mã nguồn để con người đọc, không phải để máy tính thực thi.

Trong một "Xin chào, thế giới!" chương trình, một bình luận có thể trông như thế này:

hello.py

# Print “Hello, World!” to console
print("Hello, World!")

Trong vòng lặp

# Print “Hello, World!” to console
print("Hello, World!")
2 lặp lại trong danh sách, các bình luận có thể trông như thế này:

sharks.py

# Define sharks variable as a list of strings
sharks = ['hammerhead', 'great white', 'dogfish', 'frilled', 'bullhead', 'requiem']

# For loop that iterates over sharks list and prints each string item
for shark in sharks:
   print(shark)

Nhận xét nên được thực hiện ở cùng cấp độ thụt với mã mà nó đang bình luận. Đó là, một định nghĩa chức năng không có thụt lề sẽ có một bình luận không có thụt lề, và mỗi cấp độ thụt lề sau đây sẽ có các nhận xét được liên kết với mã mà nó đang bình luận.

Ví dụ: đây là cách chức năng

# Print “Hello, World!” to console
print("Hello, World!")
3 từ cách thực hiện chương trình máy tính đơn giản trong hướng dẫn Python 3 được nhận xét, với các nhận xét theo từng cấp độ của mã:

calculator.py

...
# Define again() function to ask user if they want to use the calculator again
def again():

    # Take input from user
    calc_again = input('''
Do you want to calculate again?
Please type Y for YES or N for NO.
''')

    # If user types Y, run the calculate() function
    if calc_again == 'Y':
        calculate()

    # If user types N, say good-bye to the user and end the program
    elif calc_again == 'N':
        print('See you later.')

    # If user types another key, run the function again
    else:
        again()

Nhận xét được thực hiện để giúp các lập trình viên, cho dù đó là lập trình ban đầu hoặc người khác sử dụng hoặc hợp tác trong dự án. Nếu nhận xét không thể được duy trì và cập nhật đúng cách cùng với cơ sở mã, tốt hơn là không bao gồm một nhận xét thay vì viết một nhận xét mâu thuẫn hoặc sẽ mâu thuẫn với mã.

Khi nhận xét mã, bạn nên tìm cách trả lời lý do tại sao đằng sau mã trái ngược với những gì hoặc như thế nào. Trừ khi mã đặc biệt khó khăn, nhìn vào mã thường có thể cho biết mã đang làm gì hoặc nó đang làm như thế nào.

Nhận xét khối có thể được sử dụng để giải thích mã hoặc mã phức tạp hơn mà bạn không mong đợi người đọc sẽ quen thuộc. Những nhận xét dạng dài hơn áp dụng cho một số hoặc tất cả các mã theo sau, và cũng được thụt vào cùng cấp độ với mã.

Trong các bình luận khối, mỗi dòng bắt đầu với dấu băm và một không gian duy nhất. Nếu bạn cần sử dụng nhiều hơn một đoạn, chúng nên được phân tách bằng một dòng chứa một dấu băm đơn.

Dưới đây là một ví dụ về một bình luận khối xác định những gì đang xảy ra trong hàm

# Print “Hello, World!” to console
print("Hello, World!")
4 được xác định trong phần sau:

# The main function will parse arguments via the parser variable.  These
# arguments will be defined by the user on the console.  This will pass
# the word argument the user wants to parse along with the filename the
# user wants to use, and also provide help text if the user does not
# correctly pass the arguments.

def main():
  parser = argparse.ArgumentParser()
  parser.add_argument(
      "word",
      help="the word to be searched for in the text file."
  )
  parser.add_argument(
      "filename",
      help="the path to the text file to be searched through"
  )
...

Nhận xét khối thường được sử dụng khi các hoạt động ít hiểu hơn và do đó yêu cầu giải thích kỹ lưỡng. Bạn nên cố gắng tránh quá trình quá mức mã và nên có xu hướng tin tưởng các lập trình viên khác để hiểu Python trừ khi bạn đang viết cho một đối tượng cụ thể.

Nhận xét nội tuyến xảy ra trên cùng một dòng của một câu lệnh, theo chính mã. Giống như các bình luận khác, họ bắt đầu với một dấu băm và một ký tự khoảng trắng duy nhất.

Nói chung, các bình luận nội tuyến trông như thế này:

[code]  # Inline comment about the code

Nhận xét nội tuyến nên được sử dụng một cách tiết kiệm, nhưng có thể có hiệu quả để giải thích các phần khó khăn hoặc phức tạp của mã. Chúng cũng có thể hữu ích nếu bạn nghĩ rằng bạn có thể không nhớ một dòng mã bạn đang viết trong tương lai hoặc nếu bạn đang hợp tác với một người mà bạn biết có thể không quen thuộc với tất cả các khía cạnh của mã.

Ví dụ: nếu bạn không sử dụng nhiều toán học trong các chương trình Python của mình, bạn hoặc cộng tác viên của bạn có thể không biết rằng sau đây tạo ra một số phức, vì vậy bạn có thể muốn bao gồm một nhận xét nội tuyến về điều đó:

z = 2.5 + 3j  # Create a complex number

Nhận xét nội tuyến cũng có thể được sử dụng để giải thích lý do đằng sau việc làm một cái gì đó, hoặc một số thông tin bổ sung, như trong:

x = 8  # Initialize x with an arbitrary number

Nhận xét được thực hiện trong dòng chỉ nên được sử dụng khi cần thiết và khi nào chúng có thể cung cấp hướng dẫn hữu ích cho người đọc chương trình.

Ngoài việc sử dụng các bình luận như một cách để ghi lại mã, nhãn băm cũng có thể được sử dụng để nhận xét mã mà bạn không muốn thực thi trong khi bạn đang thử nghiệm hoặc gỡ lỗi một chương trình bạn hiện đang tạo. Đó là, khi bạn gặp lỗi sau khi thực hiện các dòng mã mới, bạn có thể muốn nhận xét một vài trong số chúng để xem liệu bạn có thể khắc phục sự cố chính xác không.

Sử dụng dấu băm cũng có thể cho phép bạn thử các lựa chọn thay thế trong khi bạn xác định cách thiết lập mã của mình. Ví dụ: bạn có thể quyết định giữa việc sử dụng vòng lặp

# Print “Hello, World!” to console
print("Hello, World!")
5 hoặc vòng
# Print “Hello, World!” to console
print("Hello, World!")
2 trong trò chơi Python và có thể nhận xét một hoặc cái khác trong khi kiểm tra và xác định cái nào có thể tốt nhất:

guess.py

import random

number = random.randint(1, 25)

# number_of_guesses = 0

for i in range(5):
# while number_of_guesses < 5:
    print('Guess a number between 1 and 25:')
    guess = input()
    guess = int(guess)

    # number_of_guesses = number_of_guesses + 1

    if guess < number:
        print('Your guess is too low')

    if guess > number:
        print('Your guess is too high')

    if guess == number:
        break

if guess == number:
    print('You guessed the number!')

else:
    print('You did not guess the number. The number was ' + str(number))

Nhận xét mã với dấu băm có thể cho phép bạn thử các phương thức lập trình khác nhau cũng như giúp bạn tìm ra nguồn lỗi thông qua việc bình luận một cách có hệ thống và chạy các phần của chương trình.

Sự kết luận

Sử dụng nhận xét trong các chương trình Python của bạn giúp làm cho các chương trình của bạn dễ đọc hơn đối với con người, bao gồm cả bản thân trong tương lai của bạn. Bao gồm các nhận xét phù hợp có liên quan và hữu ích có thể giúp những người khác hợp tác tốt hơn với bạn về các dự án lập trình và làm cho giá trị của mã của bạn rõ ràng hơn.

Từ đây, bạn có thể muốn đọc về các tài liệu của Python trong PEP 257 để cung cấp cho bạn nhiều tài nguyên hơn để ghi lại các dự án Python của bạn.