DT blogi

Keskmine programmeerija kirjutab koodi nii, et arvuti sellest aru saab. Seevastu hea programmeerija kirjutab koodi nii, et teine inimene sellest aru saab. Üks hea koodi omadus ongi vastavus standardile.

C# .Net koodistandardite osas on küllaltki asjalikud MSDN Library poolt soovitatavad juhtnöörid klasside osas. Miks just need? Väga lihtsal põhjusel – kõik C# paketid on nende järgi tehtud ning nende õppimine ei tohiks olla raske, sest just neid pakette tuleb niikuinii pidevalt kasutada.

Microsoft on teinud asja veidi lihtsamaks, VSTS-s on olemas Code Analysis. Seda saab seadistada vastavalt enda firma standarditele. Reegleid saab määrata vea (error) ja hoiatuse (warning) tasemele. Pärast Code Analysis‘e käivitamist annab see teada, milliste reeglite vastu on eksitud ja kus need eksimused asuvad.

Kellele MSDN-i soovitused ei meeldi, need võiksid vähemalt enda meeskonnaga korralikult läbi arutada, milliseid reegleid koodikirjutamisel rakendatakse.

Koodiülevaated

Koodiülevaated on seotud standarditega. Nimelt on nende ülesandeks ühtlustada meeskonna koodikirjutamisstiili, avastada vigu ja nõrkusi. Lisaks annavad koodiülevaated arendajatele rohkem teadmisi süsteemi tööst.

Võimalusi, kuidas koodiülevaated töökorraldusse sisse tuua, on mitmeid. Lähtekoodi võib kopeerida mõnda tekstifaili ning saata see teistele meeskonnaliikmetele või lasta lihtsalt kõigil koodi vastavad kommentaarid panna. Soovitav oleks kasutada mingisugust koodsõna, näiteks REVIEW, mille IDE oskaks tehtavate tööde nimekirja panna. Nii ei tohiks märkused kahe silma vahele jääda.

Kuna arendaja ei suuda päevas meeletult koodi kirjutada, siis ei tohiks ka selle ülevaatamine eriti raske olla.

Enne, kui firmas hoolega ülevaateid juurutama hakata, tuleks tähelepanu suunata ka meeskonna suurusele. Kui meeskond on suur, tuleks hoopis uurida koodi jälgimise mehhanisme ja kasutada neid. Väiksema meeskonna puhul on koodiülevaated asjalikud ja tasuvad proovimist.

Lisalugemist

MSDN Library C# koodistandardid
Artikkel koodiülevaatest (soovitused, kuidas väga riidu ei läheks)

Kirjutas Marek, 08.02.2007 kell 17:07, teemal .NET, Tarkvaraarendus, Testimine. Jälgi selle postituse kommentaare läbi RSS-uudistevoo (feed). Lisa kommentaar või tagasisideviide (trackback) oma veebilehelt või blogist.