Metadata: Koodin Tyyliohje

Koodin tyyliohje

Perusperiaatteena koodin tyyliin käytämme Sunin omia suosituksia:http://java.sun.com/docs/codeconv/

Tässä muutamia tärkeimpiä kohtia ja tarkennuksia Sunin suosituksista:

- Muuttujien nimet englanniksi - me kaikki ymmärrämme englantia kuten myös 95% maailman ohjelmoijista. Kapitalisaatio Javan mukaan, eli luokat isolla alkukirjaimella, muuttujat pienellä, vakiot kokonaan ISOLLA.

- Käytämme Javadoc-kommentteja luokkien ja julkisten metodien & muuttujien kommentointiin. Javadoc-kommentit englanniksi, jos joku tulevaisuudessa haluaa hyödyntää implementaatiotamme / osia siitä.

- Jokaisen lähdekooditiedoston alkuun C-tyylinen header jossa seuraavat tiedot:

 
/*
 * Luokan nimi
 * 
 * Versio
 *
 * Päivämäärä
 * 
 * This software is released under the GNU GPL license
 */
 

- Sisennys 4 välilyönnillä, ei tabulaattorimerkkejä

- Blokin aloittava {-merkki metodin nimen tms. perään samalle riville, }-merkki omalle rivilleen. Tässä esimerkki:

 
public int getWidth() {
    if (color == BLUE) {
        writeLog("width of blue");
    }
    else {
        writeLog("width of red");
    }
    return this.width;
}