Pravidlá písania kódu

mená premenných obsahujú len malé písmená a podtržník _
- nazov_premennej = 10
mená premenných by mali čo najlepšie vyjadrovať čo sa v nich bude nachádzať
- nazov_auta = „Mercedes“
pre znak = v priraďovacom príkaze dávame medzeru pred aj za
- nazov_premennej = 10
operácie v aritmetických výrazoch sú väčšinou tiež oddelené od operandov medzerami
- vysledok = 5 + 5
riadky programu by nemali byť dlhšie ako 79 znakov
za čiarky, ktoré napríklad oddeľujú parametre v príkaze print(), dávame vždy medzeru
- print(„Hello“, „world“)
Odsadenie Odsadenie sa vzťahuje na medzery na začiatku riadku kódu. Zatiaľ čo odsadenie v iných programovacích jazykoch je len zdrojom čitateľnosti, odsadenie v Pythone je povinné. Python používa odsadenie na otvorenie bloku kódu. Presnejšie, 4 po sebe idúce medzery na úroveň odsadenia!
Prázdne riadky – Obklopte definície funkcií a tried najvyššej úrovne dvoma prázdnymi riadkami. Definície metód vo vnútri triedy sú obklopené jedným prázdnym riadkom. Na oddelenie skupín súvisiacich funkcií možno (striedmo) použiť ďalšie prázdne riadky. Nakoniec použite prázdne riadky vo funkciách (striedmo) na označenie logických častí.
Komentáre – Komentáre sú veľmi dôležité na to, aby sme v nich uviedli poznámky pre budúcich čitateľov nášho kódu. Hoci je ťažké definovať, ako by mal byť kód komentovaný, existujú určité usmernenia, ktorými sa môžeme riadiť:
- Každý komentár, ktorý je v rozpore s kódom, je horší ako žiadny komentár. Preto je veľmi dôležité, aby sme kód aktualizovali a nezabudli aktualizovať komentáre, aby nevznikali nezrovnalosti.
- Komentáre musia byť celé vety, pričom prvé písmeno sa píše veľkým písmenom.
- Snažte sa písať komentáre v angličtine. Hoci každý môže písať svoje komentáre v jazyku, ktorý považuje za vhodný, odporúča sa písať ich v angličtine.
- Dbajte na to, aby vaše pripomienky boli jasné a ľahko zrozumiteľné pre ostatných používateľov jazyka, v ktorom píšete.
- Existujú dva typy komentárov: blokové komentáre a riadkové komentáre.
- Blokový komentár vysvetľuje kód, ktorý za ním nasleduje. Blokový komentár zvyčajne odsadzujete na rovnakej úrovni ako blok kódu. Každý riadok blokového komentára sa začína znakom # a jednou medzerou takto:

# This is a block comment
print('Welcome to DataCamp!")

Inline komentár – Na druhej strane, riadkové komentáre sa zobrazujú na rovnakej úrovni ako kód. Inline komentáre by mali byť od príkazu oddelené aspoň dvoma medzerami. Podobne ako blokový komentár, aj riadkový komentár sa začína jedným hashovým znakom (#), za ktorým nasleduje medzera a textový reťazec.

print ("Have you ever tried Python?") # This is an inline comment

Dokumentačný komentár – Dokumentačný reťazec je reťazcový literál, ktorý sa vyskytuje ako prvý príkaz v definícii modulu, funkcie, triedy alebo metódy. Zvyčajne sa dokumentačný reťazec používa na automatické generovanie dokumentácie kódu. K reťazcu doc ako takému je možné pristupovať za behu pomocou špeciálneho atribútu obj.doc daného objektu. Kvôli konzistentnosti sú reťazce doc vždy uzavreté v trojitých dvojitých úvodzovkách („““). Existujú dve formy reťazcov doc: jednoriadkové a viacriadkové reťazce doc. Jednoriadkové sú určené pre skutočne zjavné prípady. Mali by sa naozaj zmestiť na jeden riadok. Nasledujúci príklad ilustruje jednoriadkový doku reťazec vo funkcii multiply():

def multiply(x, y):
    """ Return the product of two numbers """
    result = x * y
    return result

Na druhej strane, viacriadkový reťazec dokumentu môže zahŕňať viacero riadkov. Takýto docstring by mal dokumentovať syntax funkcie skriptu a príkazového riadka, premenné prostredia a súbory. Správy o používaní môžu byť pomerne prepracované a mali by postačovať novému používateľovi na správne používanie príkazu.

def calculate_salary(hours, price=20):
    """ Return the salary according to the hours worked

    Arguments:
    hours: total hours investe
    price: price of each hours worked. Minimum price is 20 dollars
    """
    salary = hours * price
    return salary