Закоментить все строки питон

Комментирование кода в Python (Урок №5)

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

Бывает так, что программист написал программу, отложил ее в сторону на несколько дней, а потом с удивлением понимает, что уже и не помнит, что там нагородил =)

На самом деле, это частая ситуация. Я сам регулярно возвращаюсь к своим старым программам и радуюсь (но не всегда), что комментировал собственный код.

И, как результат, я быстрее понимаю, что сам и написал =)

Что такое комментирование кода?

Если кратко, то это поясняющие записи, к тем или иным командам. Можно провести аналогию с заметками на полях книги.

Но прежде чем продолжить далее, отмечу, что можете посмотреть видео (в нем больше информации, по понятным причинам), или прочитать текстовую версию чуть ниже.

Не забудьте подписаться на мой Видеоканал в Яндекс.Дзен.

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

b=3 #задаем переменную b c=5 #задаем переменную c d=b+c print(d) #выводим результат

При этом, интерпретатор Python игнорирует все символы, которые находятся после # и до конца строки.

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

b=3 #задаем переменную b c=5 #задаем переменную c d=b + c # print(c) # print(b) print(d) #выводим результат

Если мы запустим код выше на выполнение, то получим 8 (результат сложения переменных d = b + c).

закомментированы, то они не будут исполняться интерпретатором. И мы не увидим на экране, какие значения у переменных b и c.

Это полезная фича, когда тестируется программа, или ищут ошибки в коде.

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

При этом поясняющие комментарии лучше оставить.

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

Сами потом себя похвалите за предусмотрительность, когда через какое-то время вернетесь к тому ,что написали.

Как сразу закомментировать много строк кода?

Бывает так, что нужно сразу закомментировать много строк кода, которые временно нужно исключить. Если вручную ставить в начале каждой строки знак #, то можно быстро разозлиться.

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

Например, если используете PyCharm, то достаточно выделить нужный блок кода и нажать сочетание клавиш CTRL + /

Если нужно раскомментировать много строк кода, то опять выделяем нужные строки и снова нажимаем сочетание клавиш CTRL + /.

Уроки по Python 3:

Источник

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

Комментарии — это пояснения к исходному тексту программы. Это может быть описание работы какого-то класса, функции или, например, значение переменной.

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

Комментарии — это еще один способ сделать ваш код более читабельным. Они могут помочь не только другим людям читать и понимать ваш код, но и вам самим. Бывают ситуации, когда вы быстро пишете какой-то код, не комментируя ни строчки.

Разработчики часто забывают, как работает их собственный код. Особенно если он был написан давно.

Комментарии — это отличный способ быстро вспомнить свой код, написанный ранее.

Хороший комментарии должны быть:

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

Плохой комментарий описывает код, отвечая на вопрос «что делает код?». Хороший комментарий отвечает на вопрос «зачем этот код?».

О том, как правильно писать комментарии, отлично написано в книге Роберта Мартина » Чистый код «, в главе 4 «Комментарии».

PEP 8 рекомендует использовать максимум 72 символа для комментариев на одной строке. Если ваш комментарий выходит за рамки 72 символов, его рекомендуется разделить на несколько строк.

О том, как создавать однострочные и многострочные комментарии в Python, разберем ниже.

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

Чтобы написать однострочный комментарий в Python, достаточно поставить » # » перед комментарием:

# Это однострочный комментарий print(«python») # Это тоже однострочный комментарий

Python будет считать комментарием все, что находится после «#» и до конца строки.

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

Во многих языках программирования (например С++, Go, Java, JavaScript) можно создавать многострочные комментарии конструкцией вида /* */ В Python нет возможности создавать многострочные комментарии, и такая конструкция не сработает. Однако есть альтернативные решения.

Вариант #1 — писать однострочные комментарии друг за другом:

def multiline_comment_example(): # Это многострочный комментарий, оформленный # в виде однострочных комментариев, следующих # друг за другом

Вариант #2 — заключить комментарий в тройные кавычки:

«»» Это многострочный комментарий, созданный с помощью тройных кавычек «»»

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

1. На самом деле это строка, которая не назначена какой-либо переменной. Эта строка не вызывается и ни на что не ссылается, поэтому может быть использована как многострочный комментарий.
2. Если разместить такой комментарий сразу после определения функции или метода, Python будет считать его фрагментом документации, связанного с данной функцией/методом.

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

Источник

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

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

Рассмотрим типичный случай. Представим, есть большой кусок кода, который в данный момент не нужен, но который может потребоваться в будущем:

a = 5 b = 10 c = a + b print(c)

Итак, в Python есть два основных способа закомментировать код:

Использование символа решетки (#)

Символ решетки (#) используется для комментирования отдельных строк кода. Все, что следует после символа # в строке кода, Python игнорирует:

#a = 5 #b = 10 #c = a + b #print(c)

Однако, если нужно закомментировать большой блок кода, вставка # перед каждой строкой может быть утомительной.

Использование тройных кавычек («»»)

Тройные кавычки используются для комментирования больших блоков кода:

''' a = 5 b = 10 c = a + b print(c) '''

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

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

Источник