Komentarze w obliczeniach: jednostki, wzory i zamiar
Same liczby nie mają sensu — komentarze i sensowne nazwy pomagają określić, co dokładnie oznaczają.
Już szczegółowo przeanalizowaliśmy komentarze w rozdziale 3 — tutaj nie będziemy powtarzać całej lekcji, ale Skupmy się na tym, dlaczego komentarze są szczególnie przydatne w obliczeniach: jednostki pomiary, wzory i ukryte założenia.
Liczba sama w sobie nie niesie jednostki miary
Spójrz na tę linię:
distance = 120 # km
Komentarz tutaj pomaga — ale pozostaje kruchy: żyje oddzielnie od wartości i nikt nie sprawdza, czy jest nadal prawdziwy. Bardziej niezawodny (choć nie idealny) sposób — uwzględnić jednostkę bezpośrednio w nazwie:
distance_km = 120
Tak wyraźniej widać z samego kodu, co dokładnie jest przechowywane — bez potrzeby szukania komentarza obok. Wrócimy do bardziej rygorystycznych sposobów łączenia wartości z ich znaczeniem (typy, struktury danych) w następnych rozdziałach — tutaj wystarczy świadomie uświadomić sobie problem: Python nie wiedzą, że liczba 120 oznacza kilometry. Ta wiedza istnieje tylko w głowie tego, kto napisał kod — i co najwyżej w nazwie lub komentarzu.
Komentarze do wzorów i założeń
Oddzielna, bardzo przydatna rola komentarzy — wyjaśnić formułę lub zarejestrować przypuszczenie, które w innym przypadku pozostałoby „magiczną liczbą”:
#VAT w przykładzie przykładowym: 23%
vat_rate = 0.23
price = 100
total = price * (1 + vat_rate)
print(total)
vat_rate = 0.23 – sama liczba nie wyjaśnia, skąd pochodzi i co oznacza. Komentarz # НДС в учебном примере: 23 % odpowiada dokładnie na to pytanie – "dlaczego ta liczba", a nie "co robi ten łańcuch znaków".Ten sam trik przyda się dosłownie w każdej sekcji tego rozdziału — formuły na powierzchnię koła, konwersję czasu, rabaty i procenty czyta się znacznie łatwiej, jeśli obok zaznaczono, co oznacza każda liczba.