Комментарии в Python

Учимся программировать на Python

Python - один из самых востребованных языков программирования. Подпишитесь на бесплатную рассылку и получайте статьи и видео о программировании на Python. Подробнее...

Любая программа, особенно большая и сложная, должна содержать комментарии. Иначе через какое-то время даже автор программы забудет, чего он там такое понаписал, и ему будет крайне сложно вспомнить и разобраться в своём творении. Поэтому все языки программирования предусматривают возможность вставки комментариев в исходные тексты. И Python не исключение.

В этой статье и видео расскажу о том, какие бывают комментарии в Python и как ими можно управлять.

Ну а вообще виды комментариев могут ещё зависеть от среды разработки, которых для Python существует довольно много. Однако я буду рассматривать только стандартные виды комментариев. А речь будет идти о Python 3.8 и выше.

Виды комментариев в Python

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

Однострочные. Это обычно короткие комментарии, которые чаще всего записываются справа от выражения и кратко описывают действие, которое оно выполняет.
Многострочные. Такие комментарии обычно используются в начале программы (модуля) или перед крупными блоками кода (например, подпрограммами, классами и т.п.).

В некоторых языках есть несколько способов вставки комментариев, которые отличаются для многострочных и однострочных комментариев. А в некоторых языках есть только один способ. Как это сделано в Python - расскажу далее.

Однострочный комментарий в Python

Комментарий начинается с символа хэша (#), который не является частью строкового литерала, и заканчивается в конце физической строки. Комментарий означает конец логической строки, если только не будут вызваны неявные правила соединения строк. Комментарии игнорируются синтаксисом. То есть интерпретатор никак не реагирует на наличие комментария, даже если внутри комментария находится исходный код.

Пример:

a = 10 #Присвоить а значение 10

#Просто какой-то комментарий с начала строки

s = "Какой-то строковый литерал, а # это НЕ комментарий"

Многострочный комментарий в Python

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

# Это первая строка комментария
# Это вторая строка комментария
# …
# Это последняя строка комментария

Это на самом деле очень неудобно, если требуется закомментировать большое количество строк (например, какой-то глючный участок кода). Поэтому у Python есть способ комментирования блока кода (об этом в конце статьи).

Слышал, что есть какие-то хитрые способы сделать многострочный комментарий в Python. И даже видел ))) Но, поскольку они не стандартизированы, то рассказывать о них не буду.

Особенности использования комментариев при разрыве строк

При создании программ иногда выражение является очень длинным и его неудобно записывать в одну строку. Для решения этой неприятности в Python несколько физических строк исходного кода можно объединить в одну логическую с помощью символа \. Если в конце строки поставить этот символ, то интерпретатор будет считать, что следующая строка является продолжением текущей. Например:

print("000" \
      "111" \
      "222")    # Комментарий

Так вот, если строка заканчивается обратной косой чертой, то она не может содержать комментарий. Вот так делать нельзя:

print("000" \
      "111" \   # Так нельзя
      "222")    # А так можно

Обратная косая черта не продолжает комментарий. То есть если вы напишите так:

# Это комментарий \

то следующая строка не будет комментарием.

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

Обратная косая черта запрещена в любом другом месте строки за пределами строкового литерала.

Но вы можете сделать так:

print("123 \
       456")

То есть необязательно закрывать кавычки в данном случае, чтобы сделать из двух физических строк одну логическую. Но в этом примере в строку добавятся пробелы, которые будут между 123 и 456.

Неявное соединение строк

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

Dutch_months = ['Januari', 'Februari', 'Maart',     # Это голландские
                'April',   'Mei',      'Juni',      # имена
                'Juli',    'Augustus', 'September', # месяцев
                'Oktober', 'November', 'December']  # года

Строки, которые продолжаются подобным образом, могут содержать комментарии. Отступы в данном случае не имеют значения. Допускается использовать пустые строки. Между неявно объединёнными строками нет символа новой строки. Неявно объединённые строки также могут встречаться в строках, заключенных в тройные кавычки, но в этом случае они не могут содержать комментариев.

Как добавить комментарий в Python

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

Итак, способы добавления комментария:

Просто напечатать знак # и таким образом добавить комментарий
Скопировать комментарий или комментарии из другого исходного кода
Закомментировать блок кода комбинацией клавиш ALT+3 или через меню Format - Comment Out Region

Убрать комментарий также просто:

Удалить знак # в начале строки или удалить комментарий целиком
Раскомментировать блок кода комбинацией клавиш ALT+4 или через меню Format - Uncomment Region

Закомментировать или раскомментировать блок кода нельзя в Python Shell, потому что здесь в этом нет смысла - вы пишите код и сразу исполняете его.

Эта возможность есть только в редакторе исходного кода (которым вы открываете файл исходного кода). По умолчанию, напомню, при запуске IDLE открывается Python Shell.

Чтобы перейти в редактор исходного кода можно просто в Python Shell выбрать команду меню File - Open и открыть какой-либо скрипт. Тогда и откроется редактор, где вы найдёте меню Format:

P.S. Уверен, что не все об этом знали. Так что последний раздел всё-таки не совсем бесполезен.

Вступить в группу "Основы программирования"

Подписаться на канал в РУТУБ

Подписаться на Дзен-канал

Подписаться на рассылки по программированию

Все способы изучить Python

Каждый раз, изучая какую-то новую науку, мы задаёмся вопросом - где взять обучающие материалы. Конечно, сегодня нам помогает в этом Интернет. Но иногда на поиски уходит очень много времени, а нужного результата мы не получаем... Собрал для вас кучу полезных ссылок для изучения Python. не благодарите ))) Подробнее...

Главная
Контакты