Tietokoneella ohjelmoitaessa on joskus jätettävä muistiinpanoja tai kommentteja, jotta muut kehittäjät voivat selata koodiasi helposti. Olipa kyseessä avoimen lähdekoodin projekti tai oma hanke, kommentteja tarvitaan koordinoimiseksi yhteiskehittäjien ja mahdollisten tulevien kehittäjien kanssa. Ilman kommentteja koodi olisi yksinkertaisesti ylläpitämätön.
Askeleet
Vaihe 1. Ymmärrä tietokoneohjelman kommentoinnin tarkoitus
- Luettavuus on tässä tärkeintä. Kun katsot kommenttia, sinun pitäisi tietää, että se on kommentti eikä koodirivi.
- Kommentin pitäisi olla hyödyllinen paitsi sinulle myös kaikille muille, jotka saattavat lukea tietokoneohjelmasi lähdekoodin.
Vaihe 2. Ajattele lyhyttä ja yksinkertaista tapaa käsitellä pointtiasi
Kommenttien ei tarvitse olla taideteoksia. Niiden tulee olla lyhyitä, siistejä ja suoraan asiaan.
Tämä ei kuitenkaan saisi estää useiden rivien käyttöä kommentissa. Asia on, että tiedot on saatava lukijan ulottuville
Vaihe 3. Kirjoita kommentti käyttämällä ohjelmointikielen antamaa asianmukaista syntaksia
Vaihe 4. Kysy itseltäsi, onko kirjoittamasi kommentti tarpeeksi yksityiskohtainen
Kommentin pitäisi pystyä kertomaan jollekin lähdekoodia katsovalle, mitä tämä ohjelman osa todella tekee ilman, että sinun on käännettävä se ja suoritettava se. Toteutuuko kommenttisi tähän? Välittääkö se kaikki yksityiskohdat?