Комментарии в Python
В предыдущем уроке вы научились писать свою первую программу на Python. Теперь давайте изучим комментарии в Python.
Важно
Мы вводим комментарии в самом начале этой серии уроков, потому что будем использовать их для объяснения кода в последующих уроках.
Комментарии — это подсказки, которые мы добавляем в наш код, чтобы сделать его более понятным. Комментарии в Python начинаются с #. Например,
# вывести число
print(25)
Здесь # вывести число — это комментарий.
Комментарии полностью игнорируются и не выполняются редакторами кода.
Важно
Цель этого урока — помочь вам понять комментарии, поэтому вы можете игнорировать другие концепции, используемые в программе. Мы изучим их в последующих уроках.
Однострочный комментарий
Мы используем символ решётки ( # ) для написания однострочного комментария. Например,
# объявление переменной
name = "John"
# вывод имени
print(name) # John
В приведённом выше примере мы использовали три однострочных комментария:
# объявление переменной# вывод имени# John
Однострочный комментарий начинается с # и продолжается до конца строки. Мы также можем использовать однострочные комментарии рядом с кодом:
print(name) # John
Совет
Запомните комбинацию клавиш для применения комментариев. В большинстве текстовых редакторов это Ctrl + / для Windows и Cmd + / для Mac.
Многострочные комментарии
В отличие от таких языков, как C++ и Java, в Python нет специального способа писать многострочные комментарии.
Однако мы можем достичь того же эффекта, используя символ решётки (#) в начале каждой строки.
Рассмотрим пример.
# Это пример многострочного комментария
# созданного с использованием нескольких однострочных комментариев
# Код печатает текст Hello World
print("Hello, World!")
Мы также можем использовать многострочные строки в качестве комментариев:
'''Это пример
многострочного комментария'''
print("Hello, World!")
Вывод
Hello World
Примечание
Помните, что вы изучите эти концепции программирования в последующих уроках. Сейчас вы можете просто сосредоточиться на использовании комментариев.
Предотвращение выполнения кода с помощью комментариев
Комментарии полезны при отладке кода.
Если мы сталкиваемся с ошибкой при выполнении программы, вместо удаления сегментов кода мы можем закомментировать их, чтобы предотвратить выполнение. Например,
number1 = 10
number2 = 15
sum = number1 + number2
print("The sum is:", sum)
print("The product is:", product)
Здесь код выдаёт ошибку, потому что мы не определили переменную product. Вместо удаления строки, вызывающей ошибку, мы можем её закомментировать.
Например,
number1 = 10
number2 = 15
sum = number1 + number2
print("The sum is:", sum)
# print('The product is:', product)
Вывод
The sum is 25
Здесь код работает без каких-либо ошибок.
Мы устранили ошибку с помощью комментария. Теперь, если вам понадобится вычислить произведение в ближайшем будущем, вы можете раскомментировать его.
Совет
Этот подход удобен при работе с большими файлами. Вместо удаления любой строки мы можем использовать комментарии и определить, какая из них вызывает ошибку.
Зачем использовать комментарии?
Мы должны использовать комментарии:
Для будущих ссылок, так как комментарии делают наш код читаемым.
Для отладки.
Для совместной работы над кодом, так как комментарии помогают разработчикам понимать код друг друга.
Примечание
Комментарии не являются и не должны использоваться как замена для объяснения плохо написанного кода. Всегда старайтесь писать чистый, понятный код, а затем используйте комментарии как дополнение.
В большинстве случаев всегда используйте комментарии, чтобы объяснить «почему», а не «как», и всё будет в порядке.
Далее мы начнём изучать фундаментальные концепции программирования на Python.