Rozdział 3 · Twój pierwszy program w Python
Rozdział 3 · Twój pierwszy program w PythonKomentarze i czytelny kod
Drobne nawyki, które znacznie ułatwiają życie – dla twojego przyszłego ja i wszystkich, którzy będą czytać twój kod.
Komentarze
linijka zaczynająca się od #jest komentarz:
Python całkowicie go ignoruje podczas uruchamiania. Komentarze nie istnieją dla komputera, ale
Dla ludzi – w tym dla siebie za sześć miesięcy.
privet.py
# Poproś o imię, aby spersonalizować powitanie
name = input(„Jak masz na imię?”)
print(„Cześć,”, name)Dobry komentarz wyjaśnia "dlaczego" zamiast "co"
Komentuj jak
# складываем a и b powyżej linii c = a + b bezużyteczny — kod to i tak pokazuje. Przydatny komentarz wyjaśnia to, czego nie widać w samym kodzie: dlaczego wybrano właśnie takie rozwiązanie, jaka logika biznesowa za tym stoi, na co warto zwrócić uwagę w przyszłości.To całkowicie normalne, że zostawiasz więcej komentarzy na etapie nauki niż byś zrobił Doświadczony programista w gotowym projekcie – pomaga ci opowiedzieć, co robi Co łańcuch znaków. Nie martw się, jeśli nadal chcesz komentować prawie wszystko.
Nazwy plików i zmiennych
Dobry styl w nazwach oszczędza czas — zarówno Twój, jak i wszystkich, którzy czytają kod po Tobie:
- zastosowanie małych liter:
privet.py, a niePrivet.PY; - zastosowanie sensowne nazwy:
calculator.py, a niefile1.py; - dla wielu słów użyj podkreślenie:
my_first_program.pyzamiast spacji czy skrzynek. - unikać spacji w nazwach plików — są wygodne w graficznym interfejsie, ale niewygodne w terminalu, gdzie musisz uciec z każdego pola.
| Zły | Dobrze |
|---|---|
New File FINAL 2!!.py | calculator.py |
a.py | temperature_converter.py |
MyFirstProgram.py | my_first_program.py |
PEP 8
Oficjalny przewodnik stylowy Python-code to PEP 8 (peps.python.org/pep-0008) — wspomnieliśmy o nim już w Rozdziale 1. Opisuje znacznie więcej niż tylko nazwy plików, ale na razie wystarczy wiedzieć: istnieje i jego rekomendacje są podzielane przez niemal całą społeczność Python.