Tyyliohje

Ohjelma kirjoitetaan C++:lla käyttäen ANSI-C-tyyliä. Luokat ja jäsenfunktioiden nimet kirjoitetaan isolla. Käyttöliittymän luokkien nimen alkuun tulee Kl, esim. KlLuokka. Fysiikkamallin luokkien nimen alkuun tulee Fm, mikrokontrollerin Mk, anturien ja toimilaitteiden Tl. Luokkien nimissä eri sanat kirjoitetaan yhteen ja uusi sana alkaa isolla.

Muuttujat kirjoitetaan pienellä. Sanojen väliin laitetaan alaviiva. Muuttujien ja funktioiden nimet kirjoitetaan suomeksi, samoin kommentit. Kommentit aloitetaan C++: kommenttimerkeillä //. Kommentit kirjoitetaan mieluiten omalle rivilleen.

Funktioiden alkuun kirjoitetaan lyhyt kuvaus funktion toiminnasta ja käytöstä, ellei se ole aivan itsestäänselvää. Nämä kommentit laitetaan kehyksiin. Tiedoston alkuun laitetaan lyhyt kuvaus tiedoston sisällöstä, tekijän nimi, ohjelman nimi ja versionumero.

Valmiin koodin ja generaattorin tuottaman koodin muuttujia, funktionnimiä ja kommentteja ei tarvitse suomentaa. Aaltosulku laitetaan aina uudelle riville. Käytetään emacsin sisennyksiä.

Esimerkkitiedosto:

 

//---------------------------------------------------------------------------
//
//  Tiedosto:  cpu.C
//  Tekijä:    Tiina Kumento
//  Ohjelma:   uCC
//  Versio:    0.0
//
//  Tiedosto sisältää mikrokontrollerin CPU:n toteutuksen eli
//  käskyjen suorituksen ja sisäiset rekisterit. 
//
//---------------------------------------------------------------------------


#include "cpu.h"


//--------------------------------------------------------------------------- 
//
//  INC-käskyn toteutus, 8-bittinen
//
//---------------------------------------------------------------------------

byte MkCpu::Inc8(byte vanha_arvo, byte inc, m6811 *tila)
{
    int t;

    t = vanha_arvo;
    t += inc;
    aseta_nollalippu(tila, (t & 0xff) == 0);
    aseta_negat_lippu(tila, (t & 0x80) != 0);
    aseta_ylivuotolippu(state, t > 256);
    return t&0xff;
} // Inc8