Pri programiranju v računalniku je včasih treba pustiti zapiske ali komentarje, da bodo drugi razvijalci z lahkoto brskali po vaši kodi. Ne glede na to, ali gre za odprtokodni projekt ali lastniški projekt, so za uskladitev s soustvarjalci in morebitnimi prihodnjimi razvijalci potrebni komentarji. Brez komentarjev bi bila koda preprosto nezdržljiva.
Koraki
Korak 1. Razumeti namen komentiranja računalniškega programa
- Bralnost je tukaj ključna. Ko pogledate komentar, morate vedeti, da je to komentar in ne vrstica kode.
- Komentar bi moral biti koristen ne le vam, ampak tudi vsem drugim, ki bi lahko prebrali izvorno kodo vašega računalniškega programa.
2. korak. Pomislite na kratek in enostaven način, da preidete na svoje stališče
Komentarji niso nujno umetniško delo. Biti morajo jedrnate, čiste in naravnost bistvene.
To pa ne bi smelo odvračati od uporabe več vrstic za komentar. Bistvo je, da morajo informacije priti do bralca
Korak 3. Komentar napišite z ustrezno skladnjo programskega jezika
Korak 4. Vprašajte se, ali je komentar, ki ste ga napisali, dovolj podroben
Komentar bi moral nekomu, ki gleda izvorno kodo, povedati, kaj ta del programa dejansko počne, ne da bi ga bilo treba prevesti in zagnati. Ali vaš komentar to dosega? Ali posreduje vse podrobnosti?
