Bongasinpa tänä aamuna Diggistä hyvän postauksen koodin kommentoinnista.
Postauksessa kerrotaan että mikään koodi ei ole niin hyvää tai itsestäänselvää ettei se tarvitsisi minkäänlaista kommentointia. Kirjoittajan kanssa yhdyn kyllä samaan asiaan, että vastaan ei ole tullut koodia jossa olisi liikaa kommentointia.
Myönnän kyllä nyt heti alussa että itse olen aika laiska kirjoittamaan kommentteja koodiin. Yritän käyttää kuvaavia muuttujien nimiä jotta muutkin tajuaisivat koodiani.
Omasta mielestäni kommentointi on tärkeää ja siitä saa helposti selkeää. Mutta siihen kuuluu muutakin kuin kirjoittaa pari kuvaavaa riviä kommenttia mitä jokin koodinpätkä tekee. Kuvaavat muuttujan nimet on mielestäni osa sitä, ja auttaa muitakin kuin itse koodaajaa ymmärtämään koodia. Tällä tavoin koodista itsestään tulee itsestäänselvää, eikä pelkkään kommentointiin saisi turvautua.
Postauksessa on hyviä esimerkkejä kommentoinnista, kannattaa tsekata.
FacebookJos pidit tästä artikkelista, jaa se Facebook-kavereidesi kanssa!