Kodo komentavimas

Kodo komentavimas - ir programavimo komentarai - tai tas dalykas, kurio daryti nekenčia jokie programuotojai, nes tingisi, ir savaime aišku ir taip toliau. Rezultate paprastai gaunamas kodas, kuris niekaip negali būti nei pataisytas, nei pagerintas, nei pakeistas, nes niekas nesupranta, kas ten jame vyksta. Nors kažkam, kas tą kodą rašė, tuo metu atrodė, kad viskas ir taip savaime aišku.

Blogai komentuotas kodas yra viena iš esminių priežasčių, dėl kurių veikia Kernighano dėsnis, o taip pat viena iš esminių priežasčių kodo refaktoringui.

Nemaža dalimi atvejų, kai vykdomas kodo refaktoringas, pakanka tą kodą tiesiog gerai sukomentuoti. Deja, paradoksas yra toks, kad kai kodas būna visiškai nekomentuotas, tai vykdant jo refaktoringą, pagal tą patį Kernighano dėsnį būna bent du kartus paprasčiau kodą perrašyti iš naujo, negu išsiaiškinti, ką jis daro ir tada patvarkyti. Todėl refaktorinimo metu programuotojai perrašo kodą iš naujo ir, surprise surprise, jo vėl nesukomentuoja. Ir tada rezultatas tas pats - kodas lieka nesuprantamas ir po kiek laiko vėl refaktorinamas vien dėl to, kad yra nesuprantamas, ir vėl neparašant komentarų. Tokiu būdu vyksta amžinas kodo refaktoringas vien dėl nekomentavimo.

Ypatingai atsilupę nevispročiai programeriai, kad tik nereiktų rašyti komentarų, prisigalvoja visokių automatinio komentavimo softų, kurie prigeneruoja komentarų į softo vidų automatiškai. Tokie komentarai būna visiškai beprasmiai - pvz., prie funkcijos, kurios aprašyme matosi, kad ji gauna parametrus x ir y, parašomas komentaras, kad ta funkcija gauna parametrus x ir y.

Kai kurie itin nuostabūs pusgalviai, kai būna uždrausta komentarus generuoti, tokio pat prasmingumo komentarus pradeda patys rašyti prie kodų, ir tada stebisi - "o tai kas negerai, taigi aš parašiau komentarus, ko dar reikia?"

Kai kurie visai nuplaukę nuopisos, būna kad pradeda kalbėti apie save dokumentuojantį kodą, kad esą to savaime pakanka. Tai čia ta proga jums primename, kad labiausiai ir pilniausiai save dokumentuojantis kodas yra COBOL, ir tą programavimo kalbą viso pasaulio programuotojai prakeikė tą pačią dieną, kai ji buvo sukurta.

Labai senų laikų pastebėjimas, kuris pasitvirtina absoliučiais 100%: programuotojo padaryto programavimo kokybė yra nustatoma ne pagal jo parašyto kodo lygį, o pagal jo parašytų komentarų lygį. Ten, kur komentarai būna suprantami, aiškūs ir iš jų galima išsiaiškinti viską, kas vyksta - kodas veikia kuo puikiausiai, lieka pritaikomas kitiems tikslams, nesunkiai perdaromas ir taip toliau. Gi jei komentarų nėra ar iš jų neina suprasti kodo veikimo - tai būna blogai.

Kaip sako geroji praktika, komentarai turi sudaryti apie ketvirtadalį viso kodo ar daugiau, ir tas ketvirtadalis yra ne viršutinė, o apatinė leistina riba.