Tyylisäännöt

Jokaiselle kehittyy ajan myötä yksilöllinen tapa kirjoittaa koodia. Toiset kirjoittavat väljää, toiset tiivistä. Toiset kommentoivat paljon, toiset vähemmän. Jotkut käyttävät sarkaimia luovasti, toiset "normaalilla tavalla".

Kommentointi

Kommentit kirjoitetaan joko välittömästi koodirivin ylle, tai lyhyen koodirivin perään. Jälkimmäisessä tapauksessa yleensä niin, että kommentit alkavat aina samasta kohtaa ruutua. Kommentti ei myöskään saisi ylittää ruutua, vaan sitä jatketaan toiselle riville. Voit ryhmitellä kommentit alkamaan joko // tai ' riippuen "otsikkosuuruudesta". Yleensä monirivisiä (remstart..remend) kommentteja käytetään vain testausvaiheessa, ja ne siivotaan lopullisesta koodista pois.

Lisää kommentoinnista aikaisemmin tässä oppaassa.

Sisennys

Sisennä. Uuden koodilohkon alkaessa koodi tulisi sisentää yksi tai kaksi sarkainta. Kaikki esimerkkikoodit tässä manuaalissa - mukaan lukien komentojen esimerkit - näyttävät esimerkillisesti kuinka koodi tulisi sisentää.

Rivinpituus

Älä kirjoita mielellään pitempiä rivejä kuin ruudullesi mahtuu. Tästä voi mennä miinusta esimerkiksi ohjelmoinnin tentissä, joten oikea tapa kannattaa totutella heti alussa. Resoluutiostasi riippuen rivin ihannepituus on 80-200 merkkiä.

Muuttujien ja tunnisteiden nimeäminen

  • Yleensä vakiot kirjoitetaan isoilla.
  • Globaalien muuttujien eteen voidaan kirjoittaa glb, esim. glbRuutu.
  • Kuvat voidaan erottaa kirjoittamalla alkuun img, esim. imgAuto.
  • Sama juttu äänille snd, fonteille fnt, objekteille obj/par/map, videoille anim/vid jne...
  • Taulukot voidaan kirjoittaa joko isoilla tai Isolla alkukirjaimella, muuten pienellä.
  • Tyypit yleensä isoilla.
  • Tärkeät muuttujat (esim. asetukset) isoilla.
  • Normaalit muuttujat pienellä.
  • Funktiot ja muut tunnisteet Isolla alkukirjaimella, muuten pienellä.


    <<TAKAISIN