Racket
KOODIN KOMMENTOINTI
Tietokoneohjelmien lukemisen helpottamiseksi ja ohjelmoijan omien ajatusten jäsentämiseksi ohjelmiin lisätään kommenttirivejä. Kommenteihin kirjoitetaan lyhyitä kuvauksia siitä, mitä ohjelmassa tapahtuu. Kommenttirivi alkaa puolipisteellä ; ja se ei vaikuta ohjelman suoritukseen. Kommentteja voi kirjoittaa selittämään ohjelman osien tai yksittäisen ohjelmarivin toimintaa.
KOODIN SISENTÄMINEN
Ohjelmointikoodin sisentäminen selkeyttää koodia. Sisentämisen saa tehtyä ohjelmointirakenteiden mukaisesti automaattisesti CTRL+ i.
MUUTTUJIEN NIMEÄMINEN
Muuttujat kannattaa nimetä järkevästi. Ohjelmoinnissa käytetään sekä yksittäisiä kirjaimia että pitempiä, käyttötarkoitusta kuvaavia nimiä. Näissä nimissä ei saa olla välilyöntejä. Myöskään Racket-kielen komentoja ei voi käyttää tarkoittamaan jotain muuta. Nimessä ei myöskään saa olla sulku- tai heittomerkkejä eikä merkkejä ’ ` | ; # .
FUNKTION ESITTELY
Funktion kirjoittamista helpottaa funktion esittely. Funktio esitellään ensin kommenttirivillä ennen funktion määrittelyä. Pysyvä kommenttirivi merkitään kahdella puolipisteellä. Funktion esittelyssä kerrotaan funktion nimi, jonka jälkeen merkitään kaksoispiste. Tämän jälkeen kirjoitetaan muuttujan tai muuttujien tietotyyypit. Nuolen jälkeen kerrotaan, mikä funktion kutsu jälkeen näkyviin tulevan paluuarvon (output) tietotyypit. Erilaisia tietotyyppejä ovat esimerkiksi luku, kuva, totuusarvo ja merkkijono.
Esimerkki:
;; summa : Luku Luku -> Luku
FUNKTION TESTAAMINEN
Funktion kirjoittaminen ei vielä riitä, sen toiminta pitää vielä testata. Parhaiten tämä onnistuu kirjoittamalla funktiolle testitapaukset (check-expect) kaikille mahdollisille erilaisille syötteille. Esim. jos funktiossasi on ehtolause (if), sinulla pitää olla vähintään kaksi testitapausta, jotta molemmat ehtolauseen haarat tulee testattua. Jotta pystyt kirjoittamaan testit, sinun pitää tietää mitä funktion tulee oikein toimiessaan palauttaa.
Esimerkki:
(check-expect (summa 2 3) 5)