Kako napisati jasno kodo

Ko sem začela trenutno (mojo prvo) službo kot programer, sem bila seveda še začetnik v marsikateri stvari. Ena od teh je bila tudi jasnost kode, ki sem jo pisala.

Moj prvi nadrejeni in direktor v tistem času sta mi oba želela pomagati z istim nasvetom. Njun nasveti je bil, da naj se koda bere kot zgodba.

Ko sta poskušala razložiti, edina stvari, ki sem jo dobila iz njune razlage je bila, da naj si koda sledi ena za drugo. Glede na to, da računalnik kodo običajno izvaja od zgoraj navzdol, se mi je to zdelo jasno in se mi je zdelo da vsaj to delam. Vendar, in zdaj ko berem svojo staro kodo in glede na njuno mnenje, moja koda ni bila jasna.

Ne vem kakšne zgodbe ponavadi berejo ljudje, ki so zaposleni kot programerji. Imam občutek, da niso vedno isti tipi zgodb, ki jih jaz rada berem.

Jaz uživaj v zgodbah, ki niso vedno linearne (potovanje čez čas je zame eden najbolj zanimivih fanfiction zvrsti), kjer imajo osebe močno avtonomijo in ki imajo svoj karakter. Z veseljem preberem tudi kakšno zgodbo z nezanesljivim pripovedovalcem. Ali pa tako, kjer je atmosfera najbolj pomemben del zgodbe - nekatere japonske zgodbe so dober primer tega.

Če bi jaz svojo izkušnjo zgodb, ki jih berem, moja koda ne bi postala bolj berljiva. To sem imela občutek takrat in to vem zdaj.

Veliko tega, kaj naredi berljivo kodo je bilo tudi branje ogromne količine kode. Je bilo pa nekaj eksplicitnih nasvetov, ki so mi pomagali. Tako da jih bom omenila spodaj, če bodo pomagali še komu drugemu.

Koda naj bo čim manj pomaknjena notri

Vsakič, ko je prisoten če-stavek ali pa ko je prisotna zanka, se koda pomakne en korak notri. Pri Pythonu je to zapovedano, ker drugače koda ne deluje, pri drugih jezikih, kot je JavaScript, pa je to vidno, če kodo uredi samodejni urejevalec, kot je Prettier.

Da je koda bolj berljiva, naj bo čim manj notri. To je možno narediti, če je najdaljša pot (ponavadi je to pot, ko ni nič narobe) napiše prej, vse če-stavke in podobne stvari pa se postavi tako, da se stvari končajo, če je pogoj resničen.

V eni vrstici imej samo eno stvar

Ko sem prvič poslušala programiranje 1, je veliko ljudi se hvalilo s tem, kaj lahko napišejo v eni vrstici. Ampak za to, da je koda bolj berljiva je bolje, če se v eni vrstici ne dogaja preveč stvari.

Sama še vedno nisem najboljša v tem. Kar je zame enostavno za razumeti, drugim ljudem ni. Ampak poskušam paziti na to, da vsaj ne dam vsega v eno vrstico.

Za razliko od drugih, sama v prihodnosti do sedaj nisem imela problemov z razumevanjem svoje kode, če tudi je nisem pogledala več kot dve leti. Včasih se primem za glavo, kaj sem razmišljala, ampak vsaj razumem, kaj sem želela narediti.

Ko poslušam druge ljudi, imajo nekateri problem s tem, in morajo tudi sebe čez pol leta tretirati kot nekoga, ki se bo na novo spopadal z kodo. Po drugi stani pa delam z ljudmi, ki mislijo, da bom vedela kaj je narobe v trenutno, samo za to, ker sem sama enkrat delala na te kodi. Tako da tukaj je verjetno spekter.

Bodi konsistenten

Ena od stvari, ki zelo pomaga prihodnjim programerjem, je da je vse napisano v istem stilu. Če pogledaš kodo in ne moreš povedati, kdo jo je napisal, potem je koda najverjetneje napisana konsistentno.

Tako da na začetku je najlažje le imitirati kodo, ki je že napisana. Pri meni na začetku je bil problem, da so mi rekli, da tega ne smem, ker marsikateri del kode ni bil lepo napisan. Ampak deluje, in po treh letih je del te 'ne lepo napisane kode' še vedno v produkciji.

Vseeno bi rekla, da je bolje, da se stil kode spreminja počasi čez čas, in da bi tudi v tem primeru imitacija mogoče na koncu bila dobra ideja.

To so trije nasveti, ki so meni dejansko pomagali. Upam, da bodo pomagali tudi kakšnemu drugemu začetniku.