Prilikom programiranja na računaru 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 su-programerima i mogućim budućim programerima. Bez komentara, kôd bi jednostavno bio neodrživ.
Koraci
Korak 1. Shvatite svrhu komentarisanja računarskog programa
- Čitljivost je ovdje ključna. Kada pogledate komentar, trebali biste znati da je to komentar, a ne linija 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čunarskog programa.
Korak 2. Smislite kratak i jednostavan način da pređete na svoju poentu
Komentari ne moraju biti umjetničko djelo. Trebali bi biti koncizni, uredni i direktni.
To, međutim, ne bi trebalo obeshrabriti korištenje više redaka za komentar. Poenta je u tome da informacije moraju 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 biti u stanju reći nekome ko gleda izvorni kod šta taj dio programa zapravo radi, a da ga ne mora kompajlirati i pokrenuti. Da li vaš komentar to postiže? Prenosi li sve detalje?
