Kazalo:
Opredelitev - Kaj pomeni komentar?
Komentar je poseben konstrukt v programskem jeziku, ki razvijalcu programa omogoča, da omeni dodatne informacije, povezane s programom. Glavni razlog za vključitev komentarjev v programske jezike je izboljšanje prenosljivosti in vzdrževanja kode.
Techopedia razlaga Komentar
Pogosto ekipe za razvoj programske opreme sodelujejo na različnih modulih programske opreme, ki jih inšpekcijski inženirji pregledajo med postopkom testiranja. Med postopkom testiranja se morajo inženirji zavedati delovanja modula. Zato razvijalec vključi pripombe, s katerimi razloži delovanje določenega modula z navedbo veljavnih vrst vhodov, števila vhodov, algoritma, uporabljenega za obdelavo v notranjem modulu, pričakovanih izhodov in pogojev napak med obdelavo.
Komentarji pogosto vsebujejo tudi informacije o avtorju vsebine, datumu in času, ko je bila razvita ter datumu in času, ko je bila nazadnje spremenjena. Koliko podrobnosti vključiti je stvar subjektivnosti. Nekateri razvijalci so razvpiti, da sovražijo komentarje in jih gledajo kot izgubo časa. Drugi pa so komentarji nujno potrebni. Teoretično bi morala organizacija določiti vse svoje standarde kodiranja. Kljub temu pa vam bo vsakdo, ki je kodo podedoval od prejšnje razvojne ekipe, iz nekega razloga večkrat povedal, da koda nima komentarjev, ki bi jih radi videli.