Siirry sisältöön
Mikä ihmeen code conventions, en ole Ikinä kuullutkaan?
Kirjoittaja: Kari Kangasluoma / teknisen tuotannon asiantuntija
Code conventions viittaa yhteisesti sovittuihin käytäntöihin, sekä sääntöihin ohjelmakoodia kirjoittaessa. Käytännössä tämä tarkoittaa sitä, miten koodi kirjoitetaan, muotoillaan tai dokumentoidaan.
Ai miksi muka?
Yhteisesti sovitut kirjoitussäännöt auttavat ohjelmistosuunnittelijoita kirjoittamaan hyvin dokumentoitua sekä nimenomaan helppolukuista ohjelmakoodia, jota on huomattavasti helpompi tulkita jos / kun sitä joudutaan korjaamaan tai muuttamaan jälkeenpäin. Lisäksi helppoluinen ja hyvin dokumentoitu ohjelmakoodi antaa ammattitasoisen kuvan yrityksen kirjoittamasta ohjelmakoodista.
Onko pakko jos ei halua?
Ei tietenkään – on yllättävän yleistä, ettei koodia kirjoiteta näiden sääntöjen mukaan, koska se vie jonkin verran enemmän aikaa ja näin ollen tulee kalliimmaksi tuottaa, mutta kokonaisuudessaan mielestäni sääntöjä kannattaa noudattaa – ainakin jollain asteella.
Kannattaa myös huomioida, että näiden kirjoitussääntöjen mukaan ohjelmointi on paljon muutakin kuin pelkkiä muotoiluseikkoja. Code convention kertoo mm. ohjelmakoodin loogisesta rakenteesta. Ylläpidettävyyden ja jatkokehityksen kannalta ottaen ohjelmakoodia ei kannattaisi pistää yhteen, tuhansia rivejä sisältävään tiedostoon, vaan ”palastella” sopiviin osasiin (moduuleihin), joita on helpompi jatkossa muokata. Yleisesti ottaen ohjelmakoodia kirjoitettaessa kannattaa huomioida ainakin seuraavat perusasiat:
- Vältä pitkiä kokonaisuuksia ohjelmakoodissa, jaa ne mieluummin eri luokkiin.
- Yhteen funktioon ei kannata kirjoittaa satoja rivejä ohjelmakoodia, pidä funktiot lyhyinä.
- Kirjoita toiminnallisuudet geneerisesti jos mahdollista. Näin samaa toiminnallisuutta voi hyödyntää jossain toisessa asiassa.
- Vältä ”syviä” if – else -rakenteita, maksimissaan kaksi tai kolme lohkoa sisäkkäin. Tällaiset lohkorakenteet vaativat monesti paljon pähkäilyä, jotta niistä ei tulisi vaikealukuisia, mutta vakuutan, että kannattaa käyttää aikaa niiden suunnitteluun.
- Pidä ohjelmakoodin rivit lyhyinä. Älä kirjoita yli 120 (jossain tapauksissa 80 merkkiä) merkkiä sisältäviä koodinpätkiä. Jos tämä ei ole mahdollista, jaa koodi useammalle riville.
- Palauta funktiosta selkeästi yksi tai kaksi paluuarvoa. Sellainen funktio joka palauttaa useita eri arvoja, on tavattoman hankala käsitellä ”kutsujan” päässä.
- Kirjoita funktio tekemään vain yksi asia kerrallaan. Jos paluuarvoa pitää säätää – tee se toisessa funktiossa.
- Nimeä muuttujat ymmärrettävästi. On paljon helpompi ymmärtää ja seurata muuttujaa: ”html_input_fields” kuin ”hinpf” tai ”hif”. Kannattaa käyttää tässäkin englannin kieltä, vaikka suomikin on ihan jees.
- Älä toista itseäsi vaan uudelleen käytä tekemiäsi asioita. Jos tulevaisuudessa jokin muuttuu, voi olla iso työ muuttaa juttuja ympäri järjestelmää.
- Kirjoita kommentit ja kuvaukset englanniksi jos mahdollista. Toki suomen kieli on ihan ”jees”. Kommentoi paljon, koska mieluummin liikaa kuin liian vähän kommentteja.
- Vertaile aina samantyyppisiä muuttujien arvoja. Numero 1 ei ole sama kuin merkkijono ”1”. Nämä saattavat saada aikaan joskus jännyyksiä ohjelmakoodissa. Tosin kehittyneet ohjelmointityökalut ilmoittavat jos vertailu ei ole ”strict-tyyppinen”.
- Älä keksi pyörää uudelleen. Jos jokin valmiiksi tehty juttu löytyy Internetissä, käytä sitä. Tällaisia voisivat olla vaikkapa erilaiset ”frameworkit”, luokkakirjastot jne. (Huomioi lisenssiasiat käyttäessäsi valmiita kirjastoja).
Mitäs tästä nyt sitten hyödytään?
Muutamia hyötyjä mielestäni ovat ainakin:
- Ohjelmakoodi on laadukkaampaa
- helppolukuisempaa
- ymmärrettävämpää
- dokumentointi helpottuu
- helpompi ylläpitää.
Näiden hyötyjen lisäksi useat ohjelmointityökalut (IDE) osaavat hyväksikäyttää koodin kommentteja. Työkalut osaavat esimerkiksi näyttää funktioiden parametrit sekä paluuarvot, jotta niitä ei tarvitse etsiä erikseen tiedostoista. Itse olen käyttänyt jo vuosia JetBrainsin phpStormia, joka on maksullinen työkalu ja varsin mainio PHP-koodin sekä Javascriptin kirjoittamiseen. Todennäköisesti myös suosiossa oleva VS Code tukee tuota samaa ominaisuutta.
MENEVÄTKÖ KOODIT SOLMUUN?
Meiltä saat ammattitaitoisen tekkitiimin käyttöösi. Varaa Jyrkin kalenterista aika jos haluat jutella ohjelmistopalveluistamme lisää.
