Tại sao Python không có ý kiến ​​đa dòng?

OK, tôi biết rằng chuỗi ba trích dẫn có thể đóng vai trò là nhận xét đa dòng. Ví dụ,

"""Hello, I am a 
   multiline comment"""

và

'''Hello, I am a 
   multiline comment'''

Nhưng về mặt kỹ thuật nói đây là những chuỗi, đúng không?

Tôi đã googled và đọc hướng dẫn phong cách Python, nhưng tôi không thể tìm thấy câu trả lời kỹ thuật về lý do tại sao không có triển khai chính thức của multiline, / * * / loại bình luận. Tôi không có vấn đề gì khi sử dụng ba trích dẫn, nhưng tôi hơi tò mò về điều gì dẫn đến quyết định thiết kế này.

Tôi nghi ngờ bạn sẽ nhận được câu trả lời tốt hơn, "Guido không cảm thấy cần bình luận nhiều dòng".

Guido đã tweet về điều này:

Mẹo 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ã! :-)

Nhận xét nhiều dòng dễ dàng bị phá vỡ. Điều gì nếu bạn có những điều sau đây trong một chương trình máy tính đơn giản?

operation = ''
print("Pick an operation:  +-*/")
# Get user input here

Cố gắng nhận xét rằng với một nhận xét nhiều dòng:

/*
operation = ''
print("Pick an operation:  +-*/")
# Get user input here
*/

Rất tiếc, chuỗi của bạn chứa dấu phân cách nhận xét kết thúc.

Văn bản ba trích dẫn KHÔNG nên được coi là bình luận nhiều dòng; theo quy ước, họ docstrings . Họ nên mô tả những gì mã của bạn làm và cách sử dụng nó, nhưng không phải cho những thứ như bình luận ra các khối mã.

Theo Guido, các bình luận đa dòng trong Python chỉ là các bình luận một dòng liền kề (tìm kiếm "bình luận khối").

Để bình luận các khối mã, đôi khi tôi sử dụng mẫu sau:

if False:
    # A bunch of code

Điều này có thể quay trở lại khái niệm cốt lõi rằng cần có một cách rõ ràng để thực hiện một nhiệm vụ. Phong cách bình luận bổ sung thêm các biến chứng không cần thiết và có thể làm giảm khả năng đọc.

Vâng, các trích dẫn ba được sử dụng như các bình luận đa dòng trong các tài liệu. Và # bình luận được sử dụng làm bình luận nội tuyến và mọi người sử dụng nó.

Hầu hết các ngôn ngữ script cũng không có bình luận đa dòng. Có lẽ đó là nguyên nhân?

Xem PEP 0008 , phần Nhận xét

Và xem nếu trình soạn thảo Python của bạn cung cấp một số phím tắt để nhận xét khối. Emacs hỗ trợ nó, cũng như Eclipse, có lẽ hầu hết các IDE phong nha đều có.

Từ Zen của Python :

Nên có một-- và tốt nhất là chỉ có một cách rõ ràng để làm điều đó.

Cá nhân tôi nói phong cách nhận xét của tôi giống như Java

/*
 * My multi-line comment in Java
 */

Vì vậy, việc chỉ nhận xét một dòng không phải là một điều tồi tệ nếu phong cách của bạn là điển hình cho ví dụ trước bởi vì so sánh bạn có

#
# My multi-line comment in Python
#

VB.NET cũng là một ngôn ngữ chỉ bình luận một dòng và cá nhân tôi thấy khó chịu vì các bình luận cuối cùng trông ít lượt thích hơn bình luận và giống như một số trích dẫn

'
' This is a VB.NET example
'

Nhận xét chỉ một dòng cuối cùng có ít sử dụng ký tự hơn bình luận nhiều dòng và ít có khả năng thoát khỏi một số ký tự tinh ranh trong một tuyên bố regex có lẽ? Tôi có xu hướng đồng ý với Ned.

Để nhận xét một khối mã trong IDE Pycharm :

• Mã | Bình luận với Line Comment
• Windows hoặc Linux: Ctrl+/
• Hệ điều hành Mac: Command+/

# This
# is
# a 
# multi-line
# comment

Sử dụng khối nhận xét hoặc tìm kiếm và thay thế (s / ^ / # / g) trong trình chỉnh sửa của bạn để đạt được điều này.

Tôi đã giải quyết điều này bằng cách tải xuống một macro cho trình soạn thảo văn bản của tôi (TextPad) cho phép tôi tô sáng các dòng và sau đó chèn # ở đầu mỗi dòng. Một macro tương tự loại bỏ các #. Một số người có thể hỏi tại sao multiline là cần thiết nhưng nó có ích khi bạn đang cố gắng "tắt" một khối mã cho mục đích gỡ lỗi.

Đối với bất kỳ ai khác đang tìm kiếm nhận xét nhiều dòng trong Python - sử dụng định dạng ba trích dẫn có thể có một số hậu quả có vấn đề, vì tôi vừa học được cách khó khăn. Xem xét điều này:

this_dict = {
    'name': 'Bob',

"""
This is a multiline comment in the middle of a dictionary
"""

    'species': 'Cat'
}

Nhận xét nhiều dòng sẽ được nhét vào chuỗi tiếp theo, làm rối 'species'phím. Tốt hơn là chỉ sử dụng #cho ý kiến.

Bởi vì quy ước # là một quy ước phổ biến và thực sự không có bất cứ điều gì bạn có thể làm với một nhận xét nhiều dòng mà bạn không thể với một nhận xét # -ign. Đó là một tai nạn lịch sử, giống như tổ tiên của các /* ... */bình luận quay trở lại PL / I,

Giả sử rằng họ chỉ được coi là không cần thiết. Vì thật dễ dàng để chỉ gõ #a comment, các nhận xét nhiều dòng có thể chỉ bao gồm nhiều nhận xét dòng đơn.

Mặt khác, đối với HTML , cần nhiều người hơn nữa. Thật khó để tiếp tục gõ <!--comments like this-->.

Đây chỉ là một phỏng đoán .. nhưng

Bởi vì chúng là các chuỗi, chúng có một số giá trị ngữ nghĩa (trình biên dịch không loại bỏ chúng), do đó, có ý nghĩa đối với chúng được sử dụng làm tài liệu. Chúng thực sự trở thành một phần của AST , vì vậy việc trích xuất tài liệu trở nên dễ dàng hơn.

Bên cạnh đó, những bình luận đa dòng là một con chó cái . Xin lỗi, nhưng bất kể ngôn ngữ nào, tôi không sử dụng chúng cho bất kỳ mục đích nào khác ngoài mục đích gỡ lỗi. Giả sử bạn có mã như thế này:

void someFunction()
{
    Something
    /*Some comments*/
    Something else
}

Sau đó, bạn phát hiện ra rằng có một cái gì đó trong mã của bạn mà bạn không thể sửa chữa với trình gỡ lỗi, vì vậy bạn bắt đầu gỡ lỗi bằng cách nhận xét các đoạn mã nhỏ hơn và nhỏ hơn với các nhận xét đa dòng. Điều này sau đó sẽ cung cấp cho chức năng:

void someFunction()
{ /*
    Something
   /* Comments */
   Something more*/
}

Điều này thực sự gây khó chịu.

Nhận xét nhiều dòng bằng IDLE trên:

• Mac OS X , sau khi chọn mã, nhận xét một khối mã có Ctrl+ 3và bỏ ghi chú bằng Ctrl+ 4.

• Windows , sau khi chọn mã, nhận xét một khối mã có Ctrl+ Alt+ 3và bỏ ghi chú bằng Ctrl+ At+ 4.

Tôi nhớ đã đọc về một anh chàng sẽ đưa những bình luận nhiều dòng của mình vào một biến ba trích dẫn:

x = '''
This is my
super-long mega-comment.
Wow there are a lot of lines
going on here!
'''

Điều này chiếm một chút bộ nhớ, nhưng nó cung cấp cho bạn chức năng bình luận nhiều dòng và cộng với hầu hết các biên tập viên sẽ làm nổi bật cú pháp cho bạn :)

Thật dễ dàng để nhận xét mã bằng cách chỉ cần gói nó với

x = '''

và

'''