Kommentit

Kommentointi on hyvästä. Kommentoikaa!

Ohjelmointiin kuuluu kommentointi. Kun kirjoitat ohjelmakoodia, sinun tulisi myös sirotella sinne tänne kommentteja, jossa lyhyesti ilmaiset, mitä kukin koodirivi tai koodirivijoukko tekee. Voin nimittäin 99% varmuudella sanoa, että et saa omasta koodistasi kunnolla selvää, jos et ole katsonut sitä esimerkiksi pariin kuukauteen.

mystring$="Hello World"

'extract some characters from the middle
Text 0,0,Mid(mystring$,7,4)

'extract all characters starting from 3
Text 0,20,Mid(mystring$,3)

DrawScreen

WaitKey

CoolBasicille voidaan kirjoittaa kolmenlaisia kommentteja. Niiden välillä ei ole mitään eroa, se on lähinnä totuttelukysymys.

  • Kaikki merkistä ' (heittomerkki/yksinkertainen lainaus) rivin loppuun on kommenttia (näkyy yllä olevassa esimerkissä)
  • Kaikki merkeistä // eteenpäin rivin loppuun on kommenttia (C++ -käyttäjien tottumus)
  • RemStart ... RemEnd mahdollistavat monen rivin kommentoinnin kertaheitolla.

    Esimerkki monen rivin kommentoinnista

    mystring$="Hello World"

    REMSTART
    Text 0,0,Mid

    'extract all characters starting from 3
    Text 0,20,Mid(mystring$,3)
    REMEND


    DrawScreen

    WaitKey

    Kommentteja käytetään erityisesti aliohjelmien ja funktioiden alussa selvittämään lyhyesti mitä ko. funktio tekee. Kommenteissa voi mahdollisesti olla lisäselvitys parametreista ja niiden ihannearvoista.

    Kommentit ovat myös ihanteellisia koodin koristajia. Koska ne värjäytyvät muusta koodista selvästi eri värisiksi, pystyy ohjelmoija nopeasti siirtymään haluamaansa kohtaan koodissa ja etsimään paikkoja koodin seasta. Kommentteja käytetään myös yleisesti erottelemaan ja luokittelemaan koodin ydinosat, kuten kontrollit, tekoäly, efektien päivitys ja valikot. Kommenttien vakiintunut käyttö muodostuu samalla kun ohjelmointikokemuksesi kasvaa. Ajan myötä kirjoitat yhä siistimpiä ja huolitellumpia kommentteja. Varsinkin jos kirjoitat koodia muille kuin itsellesi, kunnon kommentointi parantaa koodisi luettavuutta muiden silmissä. Toisen kirjoittamasta koodista on hyvin vaikea saada tolkkua ilman kunnollista kommentointia.


    <<TAKAISIN