Комментарии — это описания в коде, которые помогают всем, кто читает, лучше понять, что и зачем делает код. Комментарии полностью игнорируются (т.е. не выполняются) интерпретаторами, они предназначены для коллег-программистов. Например:

Здесь комментариями являются следующие строчки:

   # объявляем и определяем две переменные

   # выводим результат

Типы комментариев в Python

В Python есть 2 типа комментариев:

   однострочные комментарии;

   многострочные комментарии.

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

Однострочный комментарий начинается и заканчивается на одной строке. Cимвол # используется для написания однострочного комментария. Например:

Результат:

Eric Cartman

Здесь в коде два однострочных комментария:

   # создаем переменную

   # выводим значение

Также можно использовать однострочный комментарий в строке вместе с кодом:

Здесь код до # выполняется, а код после # игнорируется интерпретатором.

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

Python не предлагает отдельного способа написания многострочных комментариев. Однако есть методы обойти эту проблему.

Решение №1: Мы можем использовать # сразу в нескольких строках, чтобы таким образом сделать многострочный комментарий. Например:

Здесь каждая строка рассматривается как однострочный комментарий, и все они игнорируются.

Решение №2: Другой способ сделать многострочный комментарий — использовать тройные кавычки, ''' или """.

Эти тройные кавычки обычно используются для значений типа string. Но если мы не присваиваем наши комментарии какой-либо переменной или функции, то это альтернативный способ написания многострочных комментариев. Интерпретатор игнорирует строку, которая не присвоена ни одной переменной или функции.

Давайте рассмотрим на практике:

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

Польза от комментариев в Python

#1. Делают код более понятным.

Если мы напишем комментарии в нашем коде, то этот код будет легче использовать в будущем. Кроме того, другим разработчикам будет легче понять наш код.

#2. Помогают при отладке кода.

Если мы получим ошибку во время работы программы, то мы можем закомментировать строку кода, которая вызывает ошибку, вместо того, чтобы удалять её. Например:

Здесь строка print('Error Line) вызывает ошибку, поэтому мы сделали её комментарием. Теперь программа работает без ошибок.

Это один из наглядных примеров того, как комментарии могут стать полезным инструментом при отладке кода.