Izvor: Startit | Petak, 24.05.2019.| 09:26
Izdvojite članak Odštampajte vijest

Često pitanje među programerima - Da li je komentarisanje koda uvijek korisno i potrebno?

(Foto: ronstik/shutterstock.com)
Treba da komentarišite svoj kod. Oko ove rečenice lako se sukobe mišljenja. Možda zato što je kliše. A kao u svakom klišeu, u njoj ima ponešto istine. Odnosno, istina je poslovično negdje između, što potvrđuju i iskustva onih koji komentarisanje koda primjenjuju u praksi.

Bez obzira na ova dva sukobljena mišljenja, iskusniji programeri uglavnom komentarišu ono što pišu, ali ne u svim situacijama. Kako kažu, potreba za time se uglavnom javlja onda kada su u pitanju kompleksni dijelovi koda.

- Trudim se da iskomentarišem sav kod prilikom čijeg pisanja sam morao da "razmislim"/isplaniram/raspišem/analiziram. Mjera u kojoj se to radi zavisi od projekta/taska/dijela sistema - kaže softver developer Vedran Mimić.

Slično je i sa Srđanom Brkićem, koji je takođe softver developer, i koji kaže da propratnu dokumentaciju piše na vrhu metoda.

- U drugim slučajevima samo kada logika nalaže (kada kod postane dovoljno kompleksan). Isto savjetujem početnicima i smatram da ne treba olako da se prepuste pisanju komentara, kod treba da bude dovoljno jasan i bez njih - kaže Brkić.

Sebastijan Vilhamer, programer u gejming industriji, često komentariše svoj kod, a početnicima jednako savjetuje da sačekaju sa pisanjem komentara.

- Što se početnika tiče, mislim da je pred njima dug put programiranja prije nego što dođe vrijeme da brinu o pisanju komentara. Za njih je važnije da pišu kod, da ga prepravljaju, brišu i ponovo pišu. Jer, svakako, većina početničkog koda bude odbačena. Kada komentarišeš ti zastaješ, razmišljaš, pokušavaš da dobiješ neku vrijednost, a to ne možeš pre nego što si napisao određenu količinu koda - poručio je Vilhamer.

Miloš Žarković, inženjer informacionih tehnologija rijetko komentariše svoj kod. Njegov stav se donekle razlilazi s ostalima. On se generalno protivi komentarisanju, jer je mišljenja da ono čini kod nejasnim.

- Smatram da količina komentara ne utiče na kvalitet koda, ali velika količina komentara na žalost u većini slučajeva ukazuje na to da kod nije dovoljno jasan, a samim tim ni kvalitetan. Moram da se ogradim, ovdje prije svega mislim na moderne high-level jezike. Početnicima bih savjetovao da probaju da refaktorišu svoj kod, a da komentare koriste kao posljednju opciju. Vjerujem da dobrom organizacijom i imenovanjem klasa, metoda i varijabli svaki kod može da postanje čitljiv i razumljiv - kaže Žarković.

Upravo je zahtjev da kod bude čitljiv i razumljiv jedna od okosnica kada govorimo o tome da li ga treba komentarisati. Zato je uobičajna praksa da kada želiš da pojasniš kod prvo pokušaš da ga napišeš na jednostavniji način, pa tek onda komentarišeš.

Srđan iz Eryce-a navodi da: "Komentar treba da kaže zašto je nešto urađeno, a kod — kako."

S druge strane, pojedini developeri smatraju da nema smisla pisati komentare u kojima se ponavlja šta kod radi ili se služiti komentarisanjem kako bi kod učinili jasnijim. U tom duhu i Srđan napominje da nema smisla pisati očigledne komentare i samo "prljati" kod, a Miloš navodi konkretnu situaciju u kojoj ne bi pisao komentare:

- Na primjer, kada imamo neku veliku metodu koja radi puno stvari, neko bi došao u iskušenje da stavi komentar iznad svakog koraka kako bi objasnio šta taj dio koda radi. U ovom slučaju ponovo preporučujem refaktorizaciju (razdvajanje cjelina u manje metode sa smislenim imenima) - kaže on.

Naravno, osim objašnjavanja komplikovanih i osjetljivih linija koda ili nekoliko linija koda (za one koji nisu autori ili za sebe), programeri u kod unose i komentare koji im služe kao bilješke da npr. rad nije završen. Međutim, po Sebastijanovom mišljenju to je drugačija vrsta problema, jer zahtjeva od programera da se sjeti i vrati na te komentare.

- Ako je kod čist, komentari nisu potrebni. Problem je što ne može sav kod da bude takav. Takođe, jedan od problema je u tome što kada jednom napišete komentar i kasnije mu se vratite obično će zastariti, jer se kod na koji se odnosi promjenio. Imaćete gomilu komentara koji više ništa ne znače, ili više nemaju smisla kao što su imali u trenutku kada ste ih pisali - kaže Sebastijan.
Unos komentara je omogućen samo ulogovanim korisnicima.