Arvutis programmeerimisel on mõnikord vaja märkmeid või kommentaare jätta, et teised arendajad saaksid teie koodi hõlpsalt sirvida. Ükskõik, kas tegemist on avatud lähtekoodiga või omandiprojektiga, on vaja kommentaare, et koordineerida koostööd kaasarendajate ja võimalike tulevaste arendajatega. Ilma kommentaarideta oleks kood lihtsalt hooldamatu.
Sammud
Samm 1. Mõistke arvutiprogrammi kommenteerimise eesmärki
- Siin on võtmetähtsus loetavus. Kommentaari vaadates peaksite teadma, et see on kommentaar, mitte koodirida.
- Kommentaar peaks olema kasulik mitte ainult teile, vaid ka kõigile teistele, kes võivad teie arvutiprogrammi lähtekoodi lugeda.
Samm 2. Mõelge lühikesele ja lihtsale viisile, kuidas oma mõttest aru saada
Kommentaarid ei pea olema kunstiteos. Need peaksid olema lühikesed, korralikud ja otse asja juurde.
See ei tohiks aga takistada kommentaarides mitme rea kasutamist. Asi on selles, et teave peab lugejani jõudma
Samm 3. Kirjutage kommentaar programmeerimiskeele antud sobiva süntaksi abil
Samm 4. Küsige endalt, kas teie kirjutatud kommentaar on piisavalt üksikasjalik
Kommentaar peaks suutma kellelegi lähtekoodi vaadates öelda, mida see programmi osa tegelikult teeb, ilma et peaksite seda kompileerima ja käivitama. Kas teie kommentaar täidab seda? Kas see annab edasi kõik üksikasjad?