Hướng dẫn what is multiple comment in python? - nhiều nhận xét trong python là gì?

Hầu hết các ngôn ngữ lập trình đều có cú pháp cho các nhận xét khối trải rộng trên nhiều dòng văn bản, như C hoặc Java:

/*
This is a block comment.
It spans multiple lines.
Nice, eh?
*/
int answer = 42;

Làm thế nào để bạn viết cùng một phong cách của nhận xét đa dòng trong Python? Câu trả lời ngắn gọn là: Bạn có thể ít nhất là không chính xác theo cách tương tự.

Python sử dụng các quy ước và cú pháp khác nhau cho các nhận xét khối trải rộng trên nhiều dòng. Trong bài viết này, bạn sẽ thấy một số tùy chọn để tạo các bình luận đa dòng trong Python thực sự hoạt động.

Tùy chọn 1: Nhận xét một dòng liên tiếp

Tùy chọn đầu tiên của bạn để nhận xét nhiều dòng mã trong Python là chỉ cần sử dụng bình luận một dòng # trên mỗi dòng:

# This is a "block comment" in Python, made
# out of several single-line comments.
# Pretty great, eh?
answer = 42

Theo kinh nghiệm của tôi, hầu hết các dự án Python đều theo phong cách này và hướng dẫn theo phong cách PEP 8 Python cũng ủng hộ các bình luận đơn lẻ lặp đi lặp lại. Vì vậy, đây là những gì tôi đã khuyên bạn nên sử dụng hầu hết thời gian. Đây cũng là cách duy nhất để viết các khối nhận xét thực tế của người Viking trong Python bị phân tích cú pháp.

Nếu điều đó làm phiền bạn rằng Python không hỗ trợ các bình luận đa dòng thích hợp vì bạn nghĩ rằng cần nhiều nỗ lực hơn để nhận xét nhiều dòng mã, thì đây là một mẹo tiện dụng cho bạn:

Hầu hết các biên tập viên mã có một lối tắt để bình luận khối. Trong thiết lập phát triển văn bản siêu phàm của tôi, tôi chỉ cần chọn một vài dòng bằng cách sử dụng các phím shift và các phím con trỏ (hoặc chuột) và sau đó tôi nhấn

# This is a "block comment" in Python, made
# out of several single-line comments.
# Pretty great, eh?
answer = 42

Điều này thậm chí còn hoạt động ngược lại, nghĩa là tôi có thể chọn một khối các nhận xét một dòng và khi tôi nhấn phím tắt ____1010, toàn bộ khối lại không được đưa ra.

Các biên tập viên khác cũng có thể thực hiện điều này quá nguyên tử, mã VS và thậm chí Notepad ++ đều có các phím tắt tích hợp để bình luận khối trong Python. Quản lý các bình luận Python của bạn theo cách thủ công là một việc vặt và tính năng biên tập viên này có thể giúp bạn tiết kiệm hàng giờ thời gian của bạn.

Tùy chọn 2: Sử dụng các chuỗi nhiều dòng làm bình luận

Một lựa chọn khác để viết các bình luận đa dòng của nhóm thích hợp trong Python là sử dụng các chuỗi nhiều dòng với cú pháp

# This is a "block comment" in Python, made
# out of several single-line comments.
# Pretty great, eh?
answer = 42

"""
This is a "block comment" in Python, made
out of a mult-line string constant.
This actually works quite well!
"""
answer = 42

Như bạn có thể thấy, bạn có thể sử dụng các chuỗi được trích xuất ba để tạo ra một cái gì đó giống như một nhận xét đa dòng trong Python. Bạn chỉ cần đảm bảo bạn thụt đầu vào chính xác

# This is a "block comment" in Python, made
# out of several single-line comments.
# Pretty great, eh?
answer = 42

# This is a "block comment" in Python, made
# out of several single-line comments.
# Pretty great, eh?
answer = 42

def add_stuff(a, b):
    result = a + b
    """
    Now we return the result, wee!
    Hurray! I'm so excited I can't contain
    my joy to just one or two lines!
    """
    return result

Chỉ cần nhớ rằng kỹ thuật này không tạo ra những bình luận thực sự của người Viking. Điều này chỉ đơn giản là chèn một hằng số văn bản mà không làm gì cả. Nó giống như chèn một chuỗi một dòng thông thường ở đâu đó trong mã của bạn và không bao giờ truy cập nó.

Tuy nhiên, một hằng số chuỗi mồ côi đã giành được hiển thị trong mã byte, thực sự biến nó thành một nhận xét đa dòng. Tại đây, bằng chứng cho thấy chuỗi không sử dụng won đã xuất hiện trong việc tháo gỡ mã byte Cpython:

>>> import dis
>>> dis.dis(add_stuff)
  2    0 LOAD_FAST      0 (a)
       2 LOAD_FAST      1 (b)
       4 BINARY_ADD
       6 STORE_FAST     2 (result)
  8    8 LOAD_FAST      2 (result)
      10 RETURN_VALUE

Tuy nhiên, hãy cẩn thận khi bạn đặt những bình luận của người Viking này vào mã. Nếu chuỗi tuân theo ngay sau một chữ ký hàm, định nghĩa lớp hoặc khi bắt đầu một mô -đun, nó sẽ biến thành một tài liệu có một ý nghĩa khác hoàn toàn trong Python:

def add_stuff(a, b):
    """
    This is now a function docstring associated
    with the function object and accessible as
    run-time metadata.
    """
    result = a + b
    return result

DocStrings (Chuỗi tài liệu của Nhật Bản) cho phép bạn liên kết tài liệu có thể đọc được với con người với các mô-đun, chức năng, lớp học và phương pháp của con người. Họ khác với nhận xét mã nguồn:

Một nhận xét được xóa bởi trình phân tích cú pháp, trong khi một tài liệu kết thúc trong mã byte và được liên kết với đối tượng được ghi lại. Nó thậm chí có thể được truy cập theo chương trình trong thời gian chạy.

Giống như tôi đã nói trước đó, cách duy nhất để nhận được các bình luận đa dòng của True True trong Python bị người phân tích cú pháp bỏ qua là sử dụng nhiều nhận xét đơn dòng #.

Tôi sẽ thừa nhận rằng tôi đã hơi ngạc nhiên khi thấy phong cách bình luận khối giả mạo này được chứng thực bởi Guido Van Rossum, người tạo ra Python:

Mẹo Python: Bạn có thể sử dụng các chuỗi nhiều dòng làm nhận xét đa dòng. Trừ khi được sử dụng làm tài liệu, họ không tạo ra mã! :-)" (Nguồn)

Nhưng ở đó, bạn có nó trong một số trường hợp sử dụng các chuỗi được trích dẫn ba để đưa ra một khối nhận xét có thể là lựa chọn đúng đắn. Cá nhân tôi sẽ cố gắng tránh chúng trong mã sẵn sàng sản xuất, nhưng thỉnh thoảng tôi sử dụng chúng khi tôi làm việc trên một tập tin nguồn để ghi chú xuống hoặc thực hiện các danh sách việc cần làm ít.

Nhận xét đa dòng trong Python-Key Takeaways

• Không giống như các ngôn ngữ lập trình khác, Python không hỗ trợ các khối nhận xét đa dòng ra khỏi hộp.
• Cách được đề xuất để nhận xét nhiều dòng mã trong Python là sử dụng các bình luận đơn liên tiếp #. Đây là cách duy nhất để có được các nhận xét mã nguồn thực sự của người dùng được loại bỏ bởi trình phân tích cú pháp Python.
• Bạn có thể xem xét sử dụng chuỗi Triple-Quate

  # This is a "block comment" in Python, made
  # out of several single-line comments.
  # Pretty great, eh?
  answer = 42
  

  2 để tạo ra một cái gì đó gần giống với các bình luận đa dòng trong Python, nhưng đây không phải là một kỹ thuật hoàn hảo và nhận xét của bạn có thể biến thành tài liệu tình cờ.