Miten tuotan selkeää koodia?

Kun toimit varsinaista ohjelmakoodia tuottavana henkilönä, kannattaa muistaa, että tuottamaasi koodia voivat jatkokehittää hyvinkin erilaisista taustoista tulevat henkilöt. Tämä mielessä pitäen varsinaisen koodin tuotannossa kannattaa pyrkiä mahdollisimman selkeään esitykseen, jotta aloittelevakin koodari pysyy kärryillä ilman, että tarvitsee turhaan pähkäillä.

Minulla on kokemusta sekä koodin tuottamisesta, että toisten tuottaman koodin selvittämisestä. Annan tässä muutaman vinkin, joista on kaikille hyötyä jatkokehityksen kannalta.

Neljä vinkkiä, joilla voit heti selkeyyttää koodiasi:

1. Kommentointi

Kommentoi ennemminkin miksi, kuin mitä. Jokaiselle riville ei tarvitse kommentoida mitä tapahtuu, vaan tarkoitus on kertoa hieman laajemmin miksi jotain tehdään ja minkä pitäisi olla lopputulema. Kommentointi kannattaa tehdä englanniksi, jotta mahdollisimman moni ymmärtää.

2. Optimointi

Nykypäivänä on turha käyttää entisaikojen nopeusoptimointeja/-kikkoja vaikka ne kuinka olisivatkin selkärangassa. Ne ovat usein melkoista ”write only” -koodia, eikä niistä jälkikäteen ota kunnolla selvää edes niiden tekijä.

Tehokkuushyöty optimointikikkojen kanssa nykyaikaisilla kääntäjillä on marginaalista. Hyötyä niistä saadaan vain embedded -järjestelmissä, joissa on oikeasti vähän muistia ja tehoton prosessori.

3. Muuttujanimet

Kaukana on se aika, kun muuttujanimessä sai olla vain kaksi kirjainta. On parempi käyttää sellaisia muuttujanimiä, jotka selittävät itse itsensä. Esimerkiksi “isSensorEnabled” on huomattavasti parempi muuttujanimi kuin pelkkä “se”.

4. If...else ja ternary

If else rakenteiden syvyys kannattaa pitää mahdollisimman pienenä. Mikäli saman if -lausekkeen sisällä on toinen if, kannattaa sille luoda oma funktionsa, joka hoitaa kyseisen ehdon itsenäisesti.

Myöskään ?-operaattoria ei kannata viljellä sisäkkäin. Mikäli jossain tulee tarvetta sisäkkäisille ?-operaatioille, niin oma funktio per ?-operaattori lienee paikallaan.

Näiden vinkkien avulla selkeytät koodiasi ja saat jatkokehitystä tekevät kollegasi paremmalle tuulelle.

Kirjoittaja Juri Laihosella on monipuolista kokemusta muiden tekemän koodin selvittämisestä.