koodikommentit
Koodikommentit ovat ohjelmointikielessä käytettyjä tekstejä, jotka on tarkoitettu ihmisille, ei koneelle. Niiden tarkoituksena on selittää koodin tarkoitus, toimintaperiaate sekä keskeiset kontekstit. Hyvin kirjoitetut kommentit helpottavat ylläpitoa, virheiden etsimistä ja jatkokehitystä, kun uusi kehittäjä saa nopeasti kuvan siitä, miksi ratkaisu valittiin.
Kommenttien tyypit vaihtelevat kielen mukaan. Yleisiä ovat inline- tai rivikommentit sekä moniriviset lohkommentit. Joissakin kielissä on
Hyvä kommentointi kuvaa muun muassa funktion tai metodin tarkoituksen, parametrit ja palautusarvon sekä sivuvaikutukset tai virheenkäsittelyn.
Parhaat käytännöt: pidä kommentit ajantasaisina ja relevantteina; kuvaa tarkoitus ja ratkaisut eikä pelkästään tehtyä koodia; pidä
Koodikommenttien rooli dokumentaatiossa ja ylläpidossa on merkittävä. Monet kielet tukevat automaattista dokumentaatiota, joka kerää ja jäsentää
Kommentit voivat vanhentua, mikä tekee niistä harhaanjohtavia. Säännöllinen tarkistus auttaa pitämään ne luotettavina.