Почему в Python нет многострочных комментариев?

Хорошо, я знаю, что строки в тройных кавычках могут служить многострочными комментариями. Например,

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

и

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

Но с технической точки зрения это строки, верно?

Я погуглил и прочитал руководство по стилю Python, но не смог найти технического ответа на вопрос, почему нет формальной реализации многострочных комментариев типа / * * /. У меня нет проблем с использованием тройных кавычек, но мне немного любопытно, что привело к этому дизайнерскому решению.

Я сомневаюсь, что вы получите лучший ответ, чем «Гвидо не чувствовал необходимости в многострочных комментариях».

Гвидо написал в твиттере об этом:

Совет по Python: Вы можете использовать многострочные строки в качестве многострочных комментариев. Если они не используются в качестве строк документации, они не генерируют код! :-)

Многострочные комментарии легко ломаются. Что делать, если у вас есть следующее в простой программе калькулятора?

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

Попробуйте прокомментировать это многострочным комментарием:

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

К сожалению, ваша строка содержит разделитель конечного комментария.

Текст в тройных кавычках НЕ должен рассматриваться как многострочный комментарий; условно, это строки документов . Они должны описывать, что делает ваш код и как его использовать, но не для таких вещей, как комментирование блоков кода.

Согласно Гвидо, многострочные комментарии в Python - это просто непрерывные однострочные комментарии (поиск по «блочным комментариям»).

Чтобы комментировать блоки кода, я иногда использую следующий шаблон:

if False:
    # A bunch of code

Это, вероятно, восходит к основной концепции, что должен быть один очевидный способ выполнить задачу. Дополнительные стили комментариев добавляют ненужные сложности и могут снизить читабельность.

Ну, тройные кавычки используются как многострочные комментарии в строках документов. И # комментарии используются как встроенные комментарии, и люди привыкли к этому.

Большинство языков сценариев также не имеют многострочных комментариев. Может в этом причина?

См. PEP 0008 , раздел Комментарии

И посмотрите, предлагает ли ваш редактор Python комбинацию клавиш для комментирования блоков. Emacs поддерживает его, как и Eclipse, предположительно большинство приличных IDE.

Из дзен питона :

Должен быть один - и желательно только один - очевидный способ сделать это.

Лично мой стиль комментария, скажем, в Java похож на

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

Так что наличие однострочных комментариев не так уж плохо, если ваш стиль типичен для предыдущего примера, потому что для сравнения вы бы имели

#
# My multi-line comment in Python
#

VB.NET также является языком с однострочными комментариями, и лично я нахожу это раздражающим, поскольку комментарии в конечном итоге выглядят менее похожими на комментарии и больше похожими на какую-то цитату

'
' This is a VB.NET example
'

В однострочных комментариях меньше использования символов, чем в многострочных комментариях, и с меньшей вероятностью они будут избегаться некоторыми хитрыми символами в выражении регулярного выражения? Я склонен согласиться с Недом, хотя.

Чтобы закомментировать блок кода в IDE Pycharm :

• Код | Комментарий с комментарием строки
• Windows или Linux: Ctrl+/
• Mac OS: Command+/

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

Для этого используйте блок комментариев или выполните поиск и замену (s / ^ / # / g) в вашем редакторе.

Я решил эту проблему, загрузив макрос для моего текстового редактора (TextPad), который позволяет мне выделять строки, а затем вставляет # в начале каждой строки. Подобный макрос удаляет #. Некоторые могут спросить, почему многострочный необходим, но это удобно, когда вы пытаетесь «отключить» блок кода для целей отладки.

Для тех, кто ищет многострочные комментарии в Python - использование формата тройных кавычек может иметь некоторые проблематичные последствия, поскольку я только что научился трудному пути. Учти это:

this_dict = {
    'name': 'Bob',

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

    'species': 'Cat'
}

Многострочный комментарий будет заправлен в следующую строку, путая 'species'ключ. Лучше просто использовать #для комментариев.

Поскольку соглашение # является распространенным, и на самом деле вы не можете ничего сделать с многострочным комментарием, чего нельзя с комментарием # -sign. Это историческая случайность, подобно происхождению /* ... */комментариев к PL / I,

Предположим, что они просто считались ненужными. Так как просто набрать#a comment текст, многострочные комментарии могут состоять из множества однострочных комментариев.

Для HTML , с другой стороны, больше нужны мультилинеры. Труднее продолжать печатать <!--comments like this-->.

Это всего лишь предположение .. но

Поскольку они являются строками, они имеют определенную семантическую ценность (компилятор от них не избавляется), поэтому имеет смысл использовать их в качестве строк документации. Они фактически становятся частью AST , поэтому извлечение документации становится проще.

Кроме того, многострочные комментарии - сука . Извините, но независимо от языка я не использую их ни для чего другого, кроме как для отладки. Скажем, у вас есть такой код:

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

Затем вы обнаруживаете, что в вашем коде есть что-то, что вы не можете исправить с помощью отладчика, поэтому вы начинаете отладку вручную, комментируя все меньшие и меньшие куски кода с помощью этих многострочных комментариев. Это тогда дало бы функцию:

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

Это действительно раздражает.

Многострочные комментарии с использованием IDLE на:

• Mac OS X , после выбора кода, закомментируйте блок кода с помощью Ctrl+ 3и раскомментируйте с помощью Ctrl+ 4.

• В Windows после выбора кода закомментируйте блок кода с помощью Ctrl+ Alt+ 3и раскомментируйте с помощью Ctrl+ At+ 4.

Я помню, как читал об одном парне, который поместил бы его многострочные комментарии в тройную кавычку:

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

Это занимает немного памяти, но дает вам возможность многострочных комментариев, и плюс большинство редакторов выделят синтаксис для вас :)

Также легко закомментировать код, просто обернув его

x = '''

и

'''