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

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

Написание комментариев в Python может быть очень простым, а создание комментария в Python начинается с символа '#'. В этой статье объясняется, как создавать многострочные комментарии в Python.

Написание многострочных комментариев в Python

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

В java мы пишем несколько комментариев следующим образом:

/ *
Выше пишем многострочный комментарий.
Этот формат комментариев не работает в Python.
* /

Вышеупомянутый метод написания комментариев также не работает в Python.

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

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

Символ '#' используется для написания однострочного комментария Python. Используя несколько последовательных однострочных комментариев, мы можем писать многострочные комментарии. Давайте посмотрим на пример этого.

#Привет всем
# это комментарий в Python
# я пишу многострочные комментарии
# используя однострочный комментарий

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

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

Использование строковых литералов для написания многострочных комментариев

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

'Мы используем строковый литерал в качестве комментария'
"Это многострочный комментарий"
'Мы печатаем программу hello world'
print ("Привет, мир")

Выход

В выходных данных вы можете видеть, что интерпретатор Python не выводит никаких ошибок и печатает сообщение Hello World.'

Использование строковых литералов в тройных кавычках для написания многострочных комментариев

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

"
Мы используем строковые литералы в тройных кавычках для многострочных комментариев
Язык программирования - Python
Напечатаем привет мир
"
print ("Привет, мир")

Выход

В выводе вы можете видеть, что интерпретатор Python не выводит никаких ошибок и печатает сообщение Hello World.'

Теперь давайте используем строковые литералы в тройных кавычках внутри функции для написания многострочных комментариев.

В данном примере мы печатаем сумму двух чисел.

def cal_sum ():
"
мы вычисляем сумму двух чисел.
Это сумма программы
"
число1 = 10
число2 = 20
print ("Сумма:", num1 + num2)
"
Основная функция Python
"
def main ():
cal_sum ()
если __name__ == "__main__":
основной()

Выход

Теперь давайте изменим отступ, и на выходе вы увидите, что интерпретатор выдает ошибку.

def cal_sum ():
"
Мы вычисляем сумму двух чисел.
Это сумма программы
"
число1 = 10
число2 = 20
print ("Сумма:", num1 + num2)
"
Основная функция Python
"
def main ():
cal_sum ()
если __name__ == "__main__":
основной()

Выход

Интерпретатор выдает ошибку отступа.

Заключение

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