В прошлом уроке мы написали свою первую программу, а сегодня мы напишем пояснения к ней. Ну чтобы не забыть, что делает эта программа. Многие новички упускают такую простую вещь, как комментирование, а потом, когда программа становится сильно большой, не могут разобраться, что у них вообще написано. И приходится переписывать.
Поэтому мы сначала научимся писать пояснения к программе. А потом уже все остальное.
Важность комментариев
В прошлом уроке мы рассмотрели базовую функцию Python print(), которая выводит в консоль текст.
Код:
print('Привет, Python!')
Вывод:
>> Привет, Python!
Вроде все просто, понятно. Но давайте забежим немного вперед: у нас впереди будет десятки различных функций и файлов, которые невозможно будет держать в голове. Что если в какой-то момент мы забудем, что делает функция print()? Или что находится в файле lessons1.py?
Для этого в Python (и других языках программирования) принято комментировать те или иные участки кода, задавать описания для файлов. Чтобы спустя время вы могли вернуться к этому файлу и без труда вспомнить, что тут лежит и как оно работает. Или вы скинете этот проект другу и он тоже смог быстро разобраться в написанном.
Как добавить комментарий в Python
Комментарий - это блок текста, который игнорируется интерпретатором Python. Такой участок не считается программой и пропускается при запуске программы. Комментарии нужны только для людей, компьютеру на них пофиг.
Чтобы добавить комментарий достаточно в начале строки добавить знак решетки '#' , а после этого написать текст, который описывает файл или участок кода. Давайте применим такой подход к функции print() и напишем, что она делает.
# Пишет в консоль текст
print('Привет, Python')
Можем перезапустить файл и получим точно такой же результат, как и в конце первого урока. Только на этот раз мы можем воспользоваться зеленым значком "Run".
Вывод:
>> Привет, Python
Давайте теперь создадим описание для файла, чтобы при открытии его сразу складывалось четкое понимание, что делает данный скрипт. Для этого мы будем использовать три одинарные кавычки. Получится примерно так:
''' Ваш комментарий '''
Первые тройные кавычки открываются комментарий, вторые - закрывают. Не забывайте закрывать комментарии!
С помощью тройных кавычек можно создавать многострочные комментарии. Например так:
'''
Номер урока
Что делаем в уроке
'''
Теперь отредактируем наш код.
Код:
'''
Урок 1.
Пишем первую программу "Привет, Python!"
'''
# Пишет в консоль текст
print('Привет, Python!')
Теперь у нас есть описание файла в самом начале файла, а также описание функции, которую мы изучили. И десятки уроков спустя, когда вы вернетесь в данный файл, вы сразу же сможете понять, что тут происходит. Здорово?
В данном уроке мы изучили важность комментирования и закомментировали нашу первую программу. В следующих уроках мы начнем программировать! До скорых встреч!
<< Пред. Урок =========== След. Урок >>