Комментарии и читаемый код
Пиши заметки для себя и держи свой код на Python простым для чтения
Главная идея: Код читают гораздо чаще, чем пишут. Комментарий — это дружеская заметка внутри программы, а понятное имя говорит, что означает значение. Вместе они делают код простым для чтения, понимания и исправления.
К концу урока ты сможешь:
- писать комментарий с помощью символа
#, - выбирать понятные имена переменных, которые говорят сами за себя,
- держать код аккуратным с помощью пробелов и пустых строк, чтобы его было легко чинить.
1. Что такое комментарий?
Комментарий — это строка (или часть строки), которую Python не выполняет. Это заметка для людей. В Python комментарий начинается со знака решётки #. Всё, что после # в этой строке, Python пропускает.
# This program greets the user by name
name = input("What is your name? ") # ask the user to type a name
print("Hello,", name) # show a friendly greetingОжидаемый вывод (после того как ты введёшь Sam):
What is your name? Sam
Hello, SamОбрати внимание на два вида комментариев: целая строка, начинающаяся с #, и короткая заметка в конце строки после кода. Python пропускает оба.
2. Python пропускает комментарии
Так как Python пропускает всё после #, комментарии никогда не меняют то, что делает программа. Можно даже «выключить» строку кода, поставив перед ней #.
# The next line is just a note for people. Python ignores it.
print("Python runs this line")
# print("Python never runs this line")Ожидаемый вывод:
Python runs this lineВторой print теперь стал комментарием и ничего не делает. Этот приём удобен, когда хочешь проверять по одной строке.