Глава 3 · Ваша первая программа на Python
Глава 3 · Ваша первая программа на PythonКомментарии и читаемый код
Небольшие привычки, которые сильно облегчают жизнь — себе будущему и всем, кто будет читать ваш код.
Комментарии
Строка, начинающаяся с #, — это комментарий:
Python полностью её игнорирует при выполнении. Комментарии существуют не для компьютера, а
для людей — включая вас самих через полгода.
privet.py
# Спрашиваем имя, чтобы персонализировать приветствие
name = input("Как вас зовут? ")
print("Привет,", name)Хороший комментарий объясняет «почему», а не «что»
Комментарий вроде
# складываем a и b над строкой c = a + b бесполезен — код и так это показывает. Полезный комментарий объясняет то, что не видно из самого кода: почему выбрано именно такое решение, какая бизнес-логика за этим стоит, на что стоит обратить внимание в будущем.На этапе обучения совершенно нормально оставлять больше комментариев, чем оставил бы опытный разработчик в готовом проекте — они помогают вам самим проговорить, что делает каждая строка. Не переживайте, если пока хочется комментировать почти всё.
Имена файлов и переменных
Хороший стиль в именах экономит время — и вам, и всем, кто читает код после вас:
- используйте строчные буквы:
privet.py, а неPrivet.PY; - используйте осмысленные имена:
calculator.py, а неfile1.py; - для нескольких слов используйте подчёркивание:
my_first_program.py, а не пробелы или регистр; - избегайте пробелов в именах файлов — они удобны в графическом интерфейсе, но неудобны в терминале, где приходится экранировать каждый пробел.
| Плохо | Хорошо |
|---|---|
New File FINAL 2!!.py | calculator.py |
a.py | temperature_converter.py |
MyFirstProgram.py | my_first_program.py |
PEP 8
Официальный гид по стилю Python-кода — PEP 8 (peps.python.org/pep-0008) — мы уже упоминали его в главе 1. Он описывает куда больше, чем имена файлов, но сейчас достаточно знать: он существует, и его рекомендации разделяет практически всё сообщество Python.