Zasady pisania kodu

Komentarze

Jeśli chcemy w kodzie umieścić komentarz, zaczynamy go od znaku krzyżyka (#). Komentarz kończy się wraz z danym wierszem kodu.

print( "Niech Moc będzie z tobą." ) # cytat pochodzi z serii "Star Wars"
print( "Zagraj to jeszcze raz, Sam. Zagraj: Jak mija czas." ) # cytat pochodzi z filmu "Casablanca"
print( "Będzie potrzebna większa łódź." ) # cytat pochodzi z filmu "Szczęki"

Jeżeli zaś chcemy umieścić w komentarzu kilka wiersz, należy linijki kodu objąć w znaki potrójnego apostrofu lub potrójnego cudzysłowu.

'''
Przykłady uzycia instrukcji print
print( "Niech Moc będzie z tobą." ) 
print( "Zagraj to jeszcze raz, Sam. Zagraj: Jak mija czas." ) 
print( "Będzie potrzebna większa łódź." )
'''

"""
Przykłady uzycia instrukcji print
print( "Niech Moc będzie z tobą." ) 
print( "Zagraj to jeszcze raz, Sam. Zagraj: Jak mija czas." ) 
print( "Będzie potrzebna większa łódź." )
"""

Wcięcia

Za pomocą wcięć wyznacza się poziomy wierszy, a tym samym sposób grupowania instrukcji. Jedno wcięcie wykonane tabulacją odpowiada czterem spacjom. Należy pamiętać, by w obrębie jednego kodu nie łączyć ze sobą wcięć zrobionych spacjami oraz tabulacjami.

Należy pamiętać o kilku podstawowych zasadach, m.in.:

• kolejne instrukcje należy zapisywać w nowych wierszach,

• zapisanie instrukcji programu rozpoczynamy od lewej strony bez żadnego odstępu, nawet 1 spacja na początku linijki może spowodować błąd,

• język Python rozróżnia wielkość liter, zmienna o nazwie dana to inna zmiennia niż Dana

• nazwy zmiennych muszą zaczynać się od litery (a‑z, A‑Z) lub znaku podkreślenia (_) i mogą zawierać litery, cyfry (0‑9) oraz znak podkreślenia; nie mogą zaczynać się od cyfry,

• wcięcia w języku Python są istotne, ponieważ są używane do oznaczania bloków kodu, takich jak funkcje, pętle i instrukcje warunkowe.

Uwagi dotyczące składni

Musimy pamiętać o regułach składni języka, jeśli nie będziemy ich stosować, programy nie będą się uruchamiały – zobaczymy komunikat błędu: SyntaxError: invalid syntax. Oto niektóre wymagane reguły oraz dobre praktyki.

Wymagane elementy – musimy o nich zawsze pamiętać:

• nazwy zmiennych nie mogą rozpoczynać się od cyfr ani składać z wielu wyrazów,

• znak : (dwukropek) poprzedza blok instrukcji (kodu),

• wcięcia oznaczają bloki kodu, powinny mieć 4 spacje wg dokumentu PEP 8

• znak = (jeden znak równości) to operator przypisania,

• a dwa znaki == (dwa znaki równości) to operator porównania.

Ważne, czyli tzw. dobre praktyki:

• nazwy zmiennych zapisujemy literami z alfabetu łacińskiego (nie używamy liter: ą, ę i podobnych znaków diakrytycznych – to może wywołać problemy w systemach o innych wersjach językowych),

• jeśli chcemy, aby nazwy zmiennych składały się z kilku słów, wyrazy łączymy znakiem _ (podkreślenia), a nie spacji,

• operatory obejmujemy znakami spacji,

• małe i duże litery są rozróżniane,

• pomiędzy nazwą funkcji a otwierającym nawiasem nie wpisujemy spacji.