Как закомментировать несколько строк в python
Python Comments is used for the non-executable statement, it helps to make the code readable. And multiline comments in Python are multiple lines of comments.
Types of Multiline Comments in Python
There are two ways by which we can add Python multiline comments in our code. They are as follows:
- Consecutive single-line comment
- Using a Multi-line string as a comment
Consecutive Single-Line Comment
In Python, the hash character(#) is used to comment on the line. Single-line comments in Python do not have to be text alone to explain the code, they can also be used to prevent Python from executing code. The hash character should be placed before each line to be considered as multiline comments in Python.
Example:
Here, the first two lines contain a hash character(#) and the interpreter prevents the two lines from execution. Then it prints the “Python Comments” and finally, it will prevent the last line from execution.
Python3
Output:
Using a Multiline String as a Comment
Python multiline comments can also be enclosed in a delimiter (“””). Again there should be no white space between delimiters (“””). They are useful when the comment text does not fit into one line, therefore needs to span across lines. This type of string literal gets ignored as it is not assigned to any variable. We can access these strings using __doc__.
Example:
Multi-line comments are used to comment on more than one line. The first line is a single-line comment. The second and third lines can be commented on using triple quotes(“”” “””). This prevents the execution of the above code. Finally, it prints “Mathematics” in the output. However, if these Python multiline comments are placed directly after a function or class signature, then these turn into docstrings.
Многострочные комментарии в Python
В Python, для однострочных комментариев используется символ # . Но если нужно закомментировать большой блок кода, то приходится приписывать # в начале каждой строки. Это очень неудобно при отладке.
Есть ли какая-то возможность использовать многострочные комментарии (аналог /* . */ из Си) в Python?
UPD:
Знаю, что различные IDE позволяют делать такие вещи автоматически, но хотелось бы более элегантного решения, не зависящего от средства редактирования кода и различных утилит.
Насколько мне известно, отдельного синтаксиса для многострочных комментариев в Python нет. В тоже время, можно использовать строковые литералы, заключенные в тройные апострофы, например так:
Строковые литералы, заключенные в тройные кавычки, могут содержать:
- кавычки ( » )
- апострофы ( ‘ )
- docstring комментарии ( «»»func desc»»» )
- переводы строк
В тоже время, стоит помнить, что такой строковый литерал не должен содержать внутри символов »’ . Это требование аналогично запрету на последовательность символов */ внутри многострочного комментария Си.
Кстати, этот же хак, предлагает использовать создатель языка Python в одном из своих твитов.
В тоже время, как верно отметил @jfs, руководство по стилю кода (pep-8) рекомендует использовать # для блочных комментариев.
Руководство по стилю кода (pep-8) рекомендует использовать # для блочных комментариев.
Но если нужно закомментировать большой блок кода, то приходится приписывать # в начале каждой строки. Это очень неудобно при отладке.
Один из явных признаков неумелого программирования — это наличие закомментированных фрагментов кода. Используйте систему контроля версий и/или ваше IDE, чтобы временно убрать/закомментировать код при отладке. Настройте ваше окружение, чтобы вы могли это делать не задумываясь, нажимая пару клавиш.
Знаю, что различные IDE позволяют делать такие вещи автоматически, но хотелось бы более элегантного решения, не зависящего от средства редактирования кода и различных утилит.
Закомментированный код не должен добавляться в систему контроля версий, поэтому для временных изменений, которые не переживут одну сессию редактирования кода, один клавишный аккорд (например, M-; в Emacs), как правило, достаточен, чтобы закомментировать/раскомментировать кусок кода.
«»»multiline string literal»»» не является многострочным комментарием в Питоне. Это просто строковая константа, которая позволяет использовать буквальные символы новой строки без экранирования (такого как \n ). Часто используется для описаний модулей, классов, функций/методов прямо в коде:
Попытка использовать «»»»»» в качестве многострочного комментария сломается на первой docstring, даже если бы не было других более подходящий решений для данной задачи.
Комментарии в Python
Комментарии — это описания в коде, которые помогают всем, кто читает, лучше понять, что и зачем делает код. Комментарии полностью игнорируются (т.е. не выполняются) интерпретаторами, они предназначены для коллег-программистов. Например:
Здесь комментариями являются следующие строчки:
# объявляем и определяем две переменные
Типы комментариев в Python
В Python есть 2 типа комментариев:
Однострочные комментарии в Python
Однострочный комментарий начинается и заканчивается на одной строке. Cимвол # используется для написания однострочного комментария. Например:
Здесь в коде два однострочных комментария:
Также можно использовать однострочный комментарий в строке вместе с кодом:
Здесь код до # выполняется, а код после # игнорируется интерпретатором.
Многострочные комментарии в Python
Python не предлагает отдельного способа написания многострочных комментариев. Однако есть методы обойти эту проблему.
Решение №1: Мы можем использовать # сразу в нескольких строках, чтобы таким образом сделать многострочный комментарий. Например:
Здесь каждая строка рассматривается как однострочный комментарий, и все они игнорируются.
Решение №2: Другой способ сделать многострочный комментарий — использовать тройные кавычки, »’ или «»» .
Эти тройные кавычки обычно используются для значений типа string. Но если мы не присваиваем наши комментарии какой-либо переменной или функции, то это альтернативный способ написания многострочных комментариев. Интерпретатор игнорирует строку, которая не присвоена ни одной переменной или функции.
Давайте рассмотрим на практике:
Эта строка не присваивается никакой переменной, поэтому она игнорируется интерпретатором. Несмотря на то, что технически это не многострочный комментарий, его можно использовать как таковой.
Польза от комментариев в Python
#1. Делают код более понятным.
Если мы напишем комментарии в нашем коде, то этот код будет легче использовать в будущем. Кроме того, другим разработчикам будет легче понять наш код.
#2. Помогают при отладке кода.
Если мы получим ошибку во время работы программы, то мы можем закомментировать строку кода, которая вызывает ошибку, вместо того, чтобы удалять её. Например:
Здесь строка print(‘Error Line) вызывает ошибку, поэтому мы сделали её комментарием. Теперь программа работает без ошибок.
Это один из наглядных примеров того, как комментарии могут стать полезным инструментом при отладке кода.
Примечание: Всегда используйте комментарии, чтобы объяснить, почему мы что-то сделали, а не как мы это сделали. Комментарии не должны заменять собой объяснение плохо написанного кода.
VS Code: How to comment out a block of Python code
To comment out a line of code in Python, you can add a # before that line. So how to comment out a block of code in Python? If you have worked with some other programming language like Javascript, Dart … then you will be familiar with / * * / syntax. However, it is impossible to do that in Python.
To comment on a block of code in Python, you will have to prefix it with # line by line. If a block of code had hundreds of lines, it would be terrible. Advertisements
Solution
Fortunately, if you use Visual Studio Code, commenting out a block of code is really quick and easy. All you need to do is select that code block with your mouse, then press the following key combination: Advertisements
- Ctrl + K, then press Ctrl + C if you’re using Windows
- Command + K, then press Command + C if you’re on a Mac
To uncomment a block of code, use your mouse to select it and then use the key combination:
- Ctrl + K, then Ctrl + U if you’re on Windows
- Command + K, then Command + U if you’re on a Mac
You can also use the following:
- Ctrl + / (the slash key) to comment and uncomment lines of Python code on Windows.
- Command + / to comment and uncomment multiple lines of Python code on Mac.
A Small Trick
If you don’t like the mentioned solution above, you can use the triple-quote trick to make a block of Python code not run. This action doesn’t actually comment out anything but only converts the code between the triple quotes to a string.
The syntax for triple quotes consists of three consecutive single or double quotes. Advertisements
Python’s triple quotes come to the rescue by allowing strings to span multiple lines, including verbatim NEWLINEs, TABs, and any other special characters.
What Next?
Hopefully, this article has made working with Python a little easier and more comfortable. If you’d like to learn more about Python, take a look at the following articles:
You can also check out our Python category page for the latest tutorials and examples.