Sisällysluettelo:
Määritelmä - Mitä kommentti tarkoittaa?
Kommentti on erityinen ohjelmointikielen rakenne, jonka avulla ohjelman kehittäjä voi mainita ohjelmaan liittyvät lisätiedot. Tärkein syy kommenttien sisällyttämiseen ohjelmointikieliin on koodin siirrettävyyden ja ylläpidettävyyden parantaminen.
Techopedia selittää kommentin
Usein ohjelmistokehitysryhmät työskentelevät yhdessä erilaisten ohjelmistomoduulien kanssa, jotka testausinsinöörit tarkistavat testausprosessin aikana. Testausprosessin aikana insinöörien on oltava tietoisia moduulin toiminnasta. Siksi kehittäjä sisällyttää kommentit selittääkseen tietyn moduulin toiminnan ilmoittamalla kelvolliset tulotyypit, tulojen lukumäärän, sisäisessä moduulissa käsittelyyn käytetyn algoritmin, odotetut tuotokset ja mahdolliset virheolosuhteet käsittelyn aikana.
Kommentit sisältävät usein myös tietoja sisällön tekijästä, päivästä ja kellonajasta, jona se on kehitetty, sekä päivästä ja kellonaikasta, jona sitä viimeksi muutettiin. Kuinka paljon yksityiskohtia sisällytetään, on kysymys subjektiivisuudesta. Jotkut kehittäjät ovat tunnetusti vihaisia kommentteja ja pitävät niitä ajanhukkaa. Muille kommentit ovat ehdottoman välttämättömiä. Teoriassa organisaation tulisi laatia kaikki koodausstandardinsa. Silti mistä tahansa syystä kuka tahansa, joka on perinyt koodin edelliseltä kehitysryhmältä, kertoo sinulle useammin kuin ei, että koodilla ei ole kommentteja, joita he olisivat halunneet nähdä.
