Koodistiil

Antud peatükis räägime, milleks on oluline koodistiil ning kuidas seda Pythoni programmeerimiskeeles jälgida.

../_images/Code-Cartoon.jpg

(allikas: 2008 Focus Shift/OSNews/Thom Holwerda)

Koodi kirjutamisel tuleb arvestada seda, et sellele kehtivad teatud normid ja standardid. Need standardid on kehtestatud selleks, et lihtsustada selge koodi kirjutamist ning vähendada tulevikus selle haldamist ja täiendamist. Igas programmeerimiskeeles on pisut erinev koodistiil ning selguse mõttes tuleb uute keelte õppimisel vaadata üle ka koodistiil. Pythoni koodistiili võtmenimeks on PEP 8 ning docstring’ide koodistiili võtmenimeks on PEP 257.

Peamised stiilireeglid

Vaatame üle mõningad peamised reeglid PEP 8 standardi järgi:

  • Funktsioonide, meetodite ja muutujate nimed kirjutatakse alati väikese algustähega ning eraldatakse alakriipsuga: lowercase_words_separated_by_underscores

  • Funktsiooni nimi peaks arusaadavalt kirjeldama, mida funktsioon teeb.

  • Matemaatiliste operaatorite ees ja järel peab kasutama tühikuid: 1 + 2 = 3

  • Konstandid kirjutatakse alati suurtähtedega, sõnad eraldatakse alakriipsuga ning konstandid asuvad mooduli tasemel: ARE_UPPERCASE

  • Klassi nime iga sõna algab suure algustähega, sõnu ei eraldata: HelloThisIsAnExampleClass

  • Mooduli (faili) struktuur algab mooduli funktsionaalsuse kirjeldusega (docstring), peale seda tulevad import laused ja seejärel juba kood.

  • Faili lõpus peab olema üks tühi rida ning funktsiooni ees peab olema kaks tühja rida. Rea lõpus ei tohi olla üleliigseid tühikuid.

  • Kommentaarid peaksid olema täislaused ning algama suure algustähega, va juhtudel kui lause algab väikese algustähega identifikaatoriga.

  • Docstring’ide stiili kohta saab lähemalt lugeda järgnevast peatükist: Dokumenteerimine.

Video koodistiili kohta

Vaata alljärgnevat videot, kus selgitatakse erinevate näidetega miks koodistiil on oluline, mida koodi kirjutades tähele panna ning mis on peamised stiilivead.

Videos kasutatud slaidid on leitavad siit: slaidid koodistiili kohta.

Rohkem lugemist

Stiilinõudeid on omajagu ja neid kõiki pole mõtet siia ümber kirjutada. Kogu nimekiri on leitav siit: https://www.python.org/dev/peps/pep-0008/

Samuti on soovitatav see artikkel, kus allpool on palju näiteid sellest, mis on hea ning mis on halb: http://docs.python-guide.org/en/latest/writing/style/