Có cách nào để tạo bình luận đa dòng trong Python không?

Gần đây tôi đã bắt đầu nghiên cứu Python , nhưng tôi không thể tìm thấy cách triển khai các bình luận nhiều dòng. Hầu hết các ngôn ngữ có biểu tượng bình luận khối như

/*

*/

Tôi đã thử điều này trong Python, nhưng nó đưa ra một lỗi, vì vậy đây có lẽ không phải là cách chính xác. Python thực sự có một tính năng bình luận nhiều dòng?

Bạn có thể sử dụng chuỗi ba trích dẫn. Khi chúng không phải là một chuỗi doc (điều đầu tiên trong một lớp / hàm / mô-đun), chúng sẽ bị bỏ qua.

'''
This is a multiline
comment.
'''

(Hãy chắc chắn thụt đầu hàng '''một cách thích hợp để tránh một IndentationError.)

Guido van Rossum (người tạo ra Python) đã tweet đây là một "mẹo chuyên nghiệp".

Tuy nhiên, hướng dẫn về phong cách của Python, PEP8, ưu tiên sử dụng các nhận xét một dòng liên tiếp và đây cũng là những gì bạn sẽ tìm thấy trong nhiều dự án. Trình soạn thảo văn bản thường có một phím tắt để làm điều này một cách dễ dàng.

Python có một cú pháp chuỗi / bình luận đa dòng theo nghĩa là trừ khi được sử dụng làm tài liệu, các chuỗi đa dòng không tạo ra mã byte - giống như các #bình luận được chuẩn bị. Trong thực tế, nó hoạt động chính xác như một bình luận.

Mặt khác, nếu bạn nói hành vi này phải được ghi lại trong tài liệu chính thức để trở thành một cú pháp nhận xét đúng, thì có, bạn sẽ đúng khi nói nó không được đảm bảo là một phần của đặc tả ngôn ngữ.

Trong mọi trường hợp, trình soạn thảo văn bản của bạn cũng có thể dễ dàng nhận xét một khu vực được chọn (bằng cách đặt riêng #trước mỗi dòng). Nếu không, chuyển sang một trình soạn thảo văn bản nào.

Lập trình trong Python mà không có các tính năng chỉnh sửa văn bản nhất định có thể là một kinh nghiệm đau đớn. Tìm trình soạn thảo phù hợp (và biết cách sử dụng nó) có thể tạo ra sự khác biệt lớn trong cách cảm nhận trải nghiệm lập trình Python.

Trình soạn thảo văn bản không chỉ có thể nhận xét các vùng đã chọn, nó cũng có thể dễ dàng dịch chuyển các khối mã sang trái và phải và nó sẽ tự động đặt con trỏ ở mức thụt dòng hiện tại khi bạn nhấn Enter. Mã gấp cũng có thể hữu ích.

Để bảo vệ chống lại sự phân rã liên kết, đây là nội dung tweet của Guido van Rossum :

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

Từ câu trả lời được chấp nhận ...

Bạn có thể sử dụng chuỗi ba trích dẫn. Khi chúng không phải là một chuỗi doc (điều đầu tiên trong một lớp / hàm / mô-đun), chúng sẽ bị bỏ qua.

Đơn giản là nó sai. Không giống như các bình luận, các chuỗi ba trích dẫn vẫn được phân tích cú pháp và phải có giá trị cú pháp, bất kể chúng xuất hiện ở đâu trong mã nguồn.

Nếu bạn cố chạy mã này ...

def parse_token(token):
    """
    This function parses a token.
    TODO: write a decent docstring :-)
    """

    if token == '\\and':
        do_something()

    elif token == '\\or':
        do_something_else()

    elif token == '\\xor':
        '''
        Note that we still need to provide support for the deprecated
        token \xor. Hopefully we can drop support in libfoo 2.0.
        '''
        do_a_different_thing()

    else:
        raise ValueError

Bạn sẽ nhận được ...

ValueError: invalid \x escape

... trên Python 2.x hoặc ...

SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 79-80: truncated \xXX escape

... trên Python 3.x.

Cách duy nhất để thực hiện nhận xét nhiều dòng mà trình phân tích cú pháp bỏ qua là ...

elif token == '\\xor':
    # Note that we still need to provide support for the deprecated
    # token \xor. Hopefully we can drop support in libfoo 2.0.
    do_a_different_thing()

Trong Python 2.7, nhận xét đa dòng là:

"""
This is a
multilline comment
"""

Trong trường hợp bạn ở trong một lớp, bạn nên tab nó đúng cách.

Ví dụ:

class weather2():
   """
   def getStatus_code(self, url):
       world.url = url
       result = requests.get(url)
       return result.status_code
   """

AFAIK, Python không có bình luận khối. Để bình luận các dòng riêng lẻ, bạn có thể sử dụng các #ký tự.

Nếu bạn đang sử dụng Notepad ++ , có một lối tắt để bình luận khối . Tôi chắc rằng những người khác như gVim và Emacs có các tính năng tương tự.

Tôi nghĩ là không, ngoại trừ một chuỗi nhiều dòng không được xử lý. Tuy nhiên, hầu hết, nếu không phải tất cả các IDE Python đều có một phím tắt để 'bình luận' nhiều dòng mã.

Nếu bạn đặt một bình luận trong

"""
long comment here
"""

ở giữa tập lệnh, Python / linters sẽ không nhận ra điều đó. Folding sẽ bị rối tung, vì nhận xét trên không phải là một phần của các khuyến nghị tiêu chuẩn. Sử dụng tốt hơn

# Long comment
# here.

Nếu bạn sử dụng Vim , bạn có thể bổ trợ như bình luận.vim , để tự động nhận xét các dòng bình luận dài bằng cách nhấn Vjgcc. Nơi Vjchọn hai dòng mã và gccnhận xét chúng.

Nếu bạn không muốn sử dụng các plugin như trên, bạn có thể sử dụng tìm kiếm và thay thế như

:.,.+1s/^/# /g

Điều này sẽ thay thế ký tự đầu tiên trên dòng hiện tại và tiếp theo #.

Không có tính năng như một bình luận nhiều dòng. #là cách duy nhất để bình luận một dòng mã. Nhiều bạn trả lời '' 'một bình luận' '' đây là giải pháp của họ.

Nó dường như hoạt động, nhưng bên '''trong Python có các dòng được bao quanh như một chuỗi thông thường mà trình thông dịch không bỏ qua như nhận xét sử dụng #.

Kiểm tra tài liệu chính thức tại đây

Thật không may, chuỗi không thể luôn luôn được sử dụng như bình luận! Vì vậy, an toàn hơn là bám vào tiêu chuẩn chuẩn bị mỗi dòng với a #.

Đây là một ví dụ:

test1 = [1, 2, 3, 4,]       # test1 contains 4 integers

test2 = [1, 2, '''3, 4,'''] # test2 contains 2 integers **and the string** '3, 4,'

Chà, bạn có thể thử điều này (khi chạy trích dẫn, đầu vào cho câu hỏi đầu tiên sẽ được trích dẫn '):

"""
print("What's your name? ")
myName = input()
print("It's nice to meet you " + myName)
print("Number of characters is ")
print(len(myName))
age = input("What's your age? ")
print("You will be " + str(int(age)+1) + " next year.")

"""
a = input()
print(a)
print(a*5)

Bất cứ điều gì kèm theo giữa """sẽ được bình luận.

Nếu bạn đang tìm kiếm bình luận một dòng thì nó #.

Nhận xét nhiều dòng trong Python:

Đối với tôi, cả '' 'và "" "đều hoạt động.

Thí dụ:

a = 10
b = 20
c = a+b
'''
print ('hello')
'''
print ('Addition is: ', a+b)

Thí dụ:

a = 10
b = 20
c = a+b
"""
print('hello')
"""
print('Addition is: ', a+b)

Các bình luận nội tuyến trong Python bắt đầu bằng một ký tự băm.

hello = "Hello!" # This is an inline comment
print(hello)

Xin chào!

Lưu ý rằng một ký tự băm trong một chuỗi ký tự chỉ là một ký tự băm.

dial = "Dial #100 to make an emergency call."
print(dial)

Quay số # 100 để thực hiện cuộc gọi khẩn cấp.

Một ký tự băm cũng có thể được sử dụng cho các nhận xét đơn hoặc nhiều dòng.

hello = "Hello"
world = "World"
# First print hello
# And print world
print(hello)
print(world)

xin chào

Thế giới

Đính kèm văn bản với ba dấu ngoặc kép để hỗ trợ chuỗi.

def say_hello(name):
    """
    This is docstring comment and
    it's support multi line.
    :param name it's your name
    :type name str
    """
    return "Hello " + name + '!'


print(say_hello("John"))

Chào John!

Kèm theo văn bản với ba trích dẫn đơn cho ý kiến ​​khối.

'''
I don't care the parameters and
docstrings here.
'''

Trên Python 2.7.13:

Độc thân:

"A sample single line comment "

Đa dòng:

"""
A sample
multiline comment
on PyCharm
"""

Visual Studio Code phổ biến chính thức chuyển đổi nhận xét nhiều dòng.

macOS: Chọn khối mã và sau đó ⌘+/

Windows: Chọn khối mã và sau đó Ctrl+/

Có, sử dụng cả hai là tốt:

'''
Comments
'''

và

"""
Comments
"""

Nhưng, điều duy nhất mà tất cả các bạn cần nhớ khi chạy trong IDE, là bạn phải 'CHẠY' toàn bộ tệp để được chấp nhận dưới dạng nhiều mã dòng. Từng dòng 'RUN' sẽ không hoạt động đúng và sẽ hiển thị lỗi.

Để nhận xét nhiều dòng mã trong Python là chỉ cần sử dụng một #nhận xét một dòng trên mỗi dòng:

# This is comment 1
# This is comment 2 
# This is comment 3

Để viết các nhận xét đa dòng thích hợp của Wikipedia trong Python là sử dụng các chuỗi nhiều dòng với """cú pháp Python có tính năng chuỗi tài liệu (hoặc docstrings). Nó cung cấp cho các lập trình viên một cách dễ dàng để thêm ghi chú nhanh với mọi mô-đun, hàm, lớp và phương thức Python.

'''
This is
multiline
comment
'''

Ngoài ra, đề cập rằng bạn có thể truy cập chuỗi bằng một đối tượng lớp như thế này

myobj.__doc__

Bạn có thể sử dụng như sau. Điều này được gọi là DockString.

def my_function(arg1):
    """
    Summary line.
    Extended description of function.
    Parameters:
    arg1 (int): Description of arg1
    Returns:
    int: Description of return value
    """
    return arg1

print my_function.__doc__

Tôi sẽ khuyên không sử dụng """cho ý kiến ​​nhiều dòng!

Dưới đây là một ví dụ đơn giản để làm nổi bật những gì có thể được coi là hành vi không mong muốn:

print('{}\n{}'.format(
    'I am a string',
    """
    Some people consider me a
    multi-line comment, but
    """
    'clearly I am also a string'
    )
)

Bây giờ hãy xem đầu ra:

I am a string

    Some people consider me a
    multi-line comment, but
    clearly I am also a string

Chuỗi nhiều dòng không được coi là nhận xét, nhưng nó được nối với nhau 'clearly I'm also a string'để tạo thành một chuỗi.

Nếu bạn muốn bình luận nhiều dòng làm như vậy theo hướng dẫn PEP 8 :

print('{}\n{}'.format(
    'I am a string',
    # Some people consider me a
    # multi-line comment, but
    'clearly I am also a string'
    )
)

Đầu ra:

I am a string
clearly I am also a string

Sử dụng IDE PyCharm.

Bạn có thể commentvà uncommentcác dòng mã bằng Ctrl + /. Ctrl + / nhận xét hoặc bỏ ghi chú dòng hiện tại hoặc một số dòng được chọn với nhận xét dòng đơn ({# in Django templates, or # in Python scripts). Pressing Ctrl+Shift+/đối với một khối mã nguồn được chọn trong mẫu Django bao quanh khối đó bằng {% comment %} and {% endcomment %}các thẻ.

---

n = 5
while n > 0:
    n -= 1
    if n == 2:
        break
    print(n)

print("Loop ended.")

Chọn tất cả các dòng rồi nhấn Ctrl + /

# n = 5
# while n > 0:
#     n -= 1
#     if n == 2:
#         break
#     print(n)

# print("Loop ended.")

Một nhận xét đa dòng không thực sự tồn tại trong Python. Ví dụ dưới đây bao gồm một chuỗi chưa được gán, được xác thực bởi Python cho các lỗi cú pháp.

Một vài trình soạn thảo văn bản, như Notepad ++ , cung cấp cho chúng tôi các phím tắt để nhận xét một đoạn mã hoặc từ được viết.

def foo():
    "This is a doc string."
    # A single line comment
    """
       This
       is a multiline
       comment/String
    """
    """
    print "This is a sample foo function"
    print "This function has no arguments"
    """
    return True

Ngoài ra, Ctrl+ Klà một phím tắt trong Notepad ++ để chặn bình luận. Nó thêm một #ở phía trước của mỗi dòng dưới sự lựa chọn. Ctrl+ Shift+ Klà dành cho khối uncomment.

Trong số các câu trả lời khác, tôi thấy cách dễ nhất là sử dụng các hàm nhận xét IDE sử dụng hỗ trợ bình luận Python #.

Tôi đang sử dụng Anaconda Spyder và nó có:

• Ctrl+ 1- Nhận xét / không chú ý
• Ctrl+ 4- Nhận xét một khối mã
• Ctrl+ 5- Bỏ ghi chú một khối mã

Nó sẽ bình luận / bỏ ghi chú một dòng / nhiều dòng mã #.

Tôi thấy nó dễ nhất

Ví dụ: một nhận xét khối:

# =============================================================================
#     Sample Commented code in spyder
#  Hello, World!
# =============================================================================

Chọn các dòng mà bạn muốn bình luận và sau đó sử dụng Ctrl+ ?để bình luận hoặc bỏ ghi chú mã Python trong trình soạn thảo Sublime Text .

Đối với dòng đơn bạn có thể sử dụng Shift+ #.