Koodin dokumentointi on tärkeää, jotta muut voivat korjata ja laajentaa koodia. Se mahdollistaa myös tietyn muuttujan tai metodin käytön tutkimisen. Kun ohjelmaa kirjoitetaan, ovat kommentit sen dokumentointi. Joskus kommentit näyttävät turhilta, mutta jos tahdot käyttää koodia uudestaan, kommenttien käyttö tekee siitä paljon helpompaa.
Processing tarjoaa kaksi tapaa kommentoida koodia: kommentit riveillä ja monen rivin kommenttiblokit.
Vain yhden rivin kommenttien kirjoittamista varten voit laittaa merkit // kommentin alkuun. Kaikki näistä merkeistä oikealle oleva teksti lasketaan kommentiksi: sitä ei oteta huomioon ohjelmaa suoritettaessa. Esimerkkejä kommenteista riveillä:
void setup() {
// Määritellään ikkunan koko
size(400, 300);
smooth(); // Aktivoidaan ääriviivojen siistiminen
}
Jos selitys vaatii pidemmän kommentin, se voidaan kirjoittaa useammalle riville laittamalla ne merkkien "/*" kommentti "*/" väliin. Esimerkiksi:
/* Metodi alustaa ohjelman setup(), voimme määritellä ikkunan koon, asettaa ohjelman alkutilan jne. */ void setup() { }
Voit kommentoida rivin menemällä edit-valikkoon ja napsauttamalla "comment/uncomment" -nappia. Voimme tehdä saman poistaaksemme kommenttiblokin.
Ohjelman kommentointi ei merkitse jokaisen rivin merkityksen selittämistä! Yleensä kommenttiblokki selittää metodien käyttötarkoituksen ja -tavan. Tämä vaatii jättämään tavalliset Processingin komennot selittämättä: esimerkiksi setup(), draw() jne. voidaan jättää selittämättä. Yleisiä komentoja ei tarvitse kommentoida. Esimerkiksi size(), fill() ja ellipse() ovat ilmeisiä.
Kun ohjelman rivit tekevät yhteisen kommentin, kannattaa laittaa erillisten kommenttien sijasta yksi kommentti. Esimerkiksi:
x = x + 10; //Lisätään 10 koordinaattiin x y = y + 10; //Lisätään 10 koordinaattiin y
Voitaisiin kirjoittaa:
//Koordinaattien x ja y muokkaaminen x = x + 10; y = y + 10;
There has been error in communication with Booktype server. Not sure right now where is the problem.
You should refresh this page.