Чому Python не має багаторядкових коментарів?

Гаразд, я знаю, що рядки з трьома цитатами можуть слугувати як багаторядкові коментарі. Наприклад,

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

і

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

Але технічно кажучи це рядки, правда?

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

Сумніваюсь, ви отримаєте кращу відповідь, ніж "Гуйдо не відчував потреби в багаторядкових коментарях".

Гідо написав твіт про це:

Порада Python: Ви можете використовувати багаторядкові рядки як багаторядкові коментарі. Якщо вони не використовуються як docstrings, вони не генерують код! :-)

Багаторядкові коментарі легко порушуються. Що робити, якщо у звичайній програмі калькулятора є наступне?

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'ключ. Краще просто використовувати #для коментарів.

Оскільки # конвенція є загальною, і насправді нічого не можна зробити з багаторядковим коментарем, що не можна з коментарем # -підпис. Це історична випадковість, подібно до назви /* ... */коментарів, що повертаються до PL / I,

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

З іншого боку, для HTML є потреба в мультилінерах. Важче продовжувати друкувати <!--comments like this-->.

Це лише здогадка .. але

Оскільки вони є рядками, вони мають деяке смислове значення (компілятор не позбавляється від них), тому має сенс використовувати їх як docstrings. Вони фактично стають частиною 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 = '''

і

'''