Devikoneella yhteinen intohimomme on kirjoittaa hyvää ja laadukasta koodia. Koska puhumme usein hyvästä koodista, on hyvä avata mitä tällä tarkoitamme.
Ensinnäkin, hyvän koodin tunnistaa sen komplementin, huonon koodin, puuttumisen kautta. Toisin kuin muussa taiteessa, hyvässä koodissa on tietyt lainalaisuudet, ja jos niitä ei noudata, koodi ikään kuin pilaantuu ja alkaa ”haisemaan”.
Mitä siis ovat koodin hajut (code smells)?
Koodin hajut ovat merkkejä siitä, että jossain koodissa voi olla ongelmia tai se voi olla huonosti suunniteltua. Ne ovat yleisiä koodin laadun ongelmia, jotka eivät ole välttämättä vikoja, mutta voivat tehdä koodin ylläpidosta ja kehittämisestä hankalampaa. Ne voivat myös osoittaa, että koodissa on järjestelmän toiminnallisuuksien tai arkkitehtuurin ongelmia.
Esimerkiksi seuraavat asiat voivat olla koodin hajuja:
- Liian pitkät metodit tai luokat: Tämä voi osoittaa, että metodi tai luokka tekee liikaa tai että se on huonosti jäsennelty.
- Liian monimutkaiset if-lausekkeet tai silmukat: Tämä voi osoittaa, että koodissa on liikaa logiikkaa tai että se on huonosti jäsennelty.
- Liian paljon parametreja: Tämä voi osoittaa, että metodi tai luokka tekee liikaa tai että se on huonosti suunniteltu.
- Liian usein kutsutut metodit: Tämä voi osoittaa, että koodissa on liikaa toistoa tai että se on huonosti suunniteltu.
Koodin hajut eivät ole vikoja, mutta ne voivat osoittaa, että koodissa on ongelmia tai että se on huonosti suunniteltu. Ne ovat hyödyllisiä huomata, sillä ne voivat auttaa parantamaan koodin laatua ja tekemään siitä ylläpidettävämpää ja kehittämisen helpompaa.
Hyvä koodi on siistiä
Yhtenä laadun johtamismenetelmänä ylläpidämme sekä laadunhallinnan käsikirjaa, että integraatiokehittäjän käsikirjaa, jotka kertovat miten integraatioiden kehittämissä päästään huippuluokan laadullisiin suorituksiin. Laadusta puhuttaessa on toki muistettava, että hyvä koodi on yksi laadun perusta, mutta ei vielä itsessään riitä takaamaan kokonaisvaltaista laatua.
Tässä on joitain tunnusmerkkejä hyvästä ja siististä koodista:
- Se on luettavissa ja ymmärrettävissä: Hyvä koodi on kirjoitettu selkeällä ja yksinkertaisella kielellä, ja se on organisoitu ja strukturoitu siten, että se on helppo ymmärtää. Itse tykkään sanoa, että koodia pitää pystyä lukemaan kuin Aku Ankkaa.
- Se noudattaa koodausstandardeja ja -käytäntöjä: Hyvä koodi noudattaa yleisiä koodausstandardeja ja -käytäntöjä, kuten nimeämis- ja muotoilusääntöjä. Näin se on yhtenäistä ja helposti luettavaa muiden kehittäjien kanssa.
- Se on dokumentoitu: Hyvä koodi sisältää tarpeeksi kommentteja ja dokumentaatiota, jotta sen käyttötarkoitus ja toiminta ovat selvillä.
- Se on optimoitu: Hyvä koodi on optimoitu suorituskyvyn ja tehokkuuden suhteen. Se ei sisällä turhia toimintoja tai ineffektiivisiä ratkaisuja.
- Se on testattu: Hyvä koodi on testattu ja varmennettu ennen sen julkaisua tuotantokäyttöön. Se sisältää myös riittävän määrän testejä varmistaakseen, että se toimii oikein eri tilanteissa.
- Se on ylläpidettävissä: Hyvä koodi on suunniteltu siten, että se on helppo ylläpitää ja päivittää. Se on myös järjestelmällisesti organisoitu ja selkeästi rakennettu, jotta sen muokkaaminen ja ylläpitäminen on mahdollisimman vaivatonta.
- Suosittelen aiheesta kiinnostuneita lukemaan erityisesti Robert C. Martinin erinomaisen kirjan ”Clean code”.
Tunnistatko itsessäsi saman intohimon tuottaa laadukasta koodia? Vinkki; Devikoneella pääset varmasti tuottamaan koodia laatu edellä😊.