Prilikom programiranja na računalu ponekad je potrebno ostaviti bilješke ili komentare kako bi drugi programeri mogli s lakoćom pregledavati vaš kôd. Bilo da se radi o projektu otvorenog koda ili vlasničkom projektu, komentari su potrebni kako bi se koordinirali sa surazvijačima i mogućim budućim programerima. Bez komentara, kôd bi jednostavno bio neodrživ.
Koraci
Korak 1. Shvatite svrhu komentiranja računalnog programa
- Čitljivost je ovdje ključna. Kad gledate komentar, trebali biste znati da je to komentar, a ne redak koda.
- Komentar bi također trebao biti koristan ne samo vama, već i svima drugima koji bi mogli pročitati izvorni kod vašeg računalnog programa.
Korak 2. Smislite kratak i jednostavan način da pređete na svoju stvar
Komentari ne moraju biti umjetničko djelo. Trebali bi biti jezgroviti, uredni i direktni do suštine.
To, međutim, ne bi trebalo obeshrabriti korištenje više redaka za komentar. Poanta je u tome da informacije trebaju doći do čitatelja
Korak 3. Napišite komentar koristeći odgovarajuću sintaksu koju daje programski jezik
Korak 4. Zapitajte se je li komentar koji ste napisali dovoljno detaljan
Komentar bi trebao moći reći nekome tko gleda izvorni kod što taj dio programa zapravo radi, a da ga ne mora sastaviti i pokrenuti. Postiže li to vaš komentar? Prenosi li sve detalje?
