Kildekode-formaterings tips

Fra Hiofwiki

Å programmere kan i begynnelsen være vanskelig. Et godt tips for å ikke gjøre det unødvendig komplisert er å formatere kildekoden ordentlig. Under følger noen få men utrolig hjelpsomme tips.

Indentering

Kildekode i stort sett alle språk er strukturert hierarkisk. Det er derfor svært så hjelpsomt å la dette hierarkiet også være synlig i identeringen. Noen eksempler: la alle metoder tilhørende en klasse starte på samme kolonne i kildekoden, la alle avsluttende braketter (}) ligge på en ny linje i samme kolonne som kildekodegruppen den avslutter, la alle uttrykk i samme kildekodegruppe starte på samme kolonne. Generelt sett bør all kode på samme "nivå" ligge på samme kolonne i koden.

Et godt eksempel på god kodestil:

public class Opg1_1                                                                                                                                                            
{                                                                                                                                                                              
    public static void main(String[] Args)                                                                                                                                    
    {                                                                                                                                                                          
        System.out.println("Hello, world!");
    }

    public static void metode(int num)
    {
        if(num == 3)
        {
            System.out.println("Tre");
        }
        else
        {
            System.out.println("Ikke tre");
        }
    }                                                                                                                                                                    
}

Gruppering

Når kildekoden blir større, blir den også lettere uoversiktlig. Dette kan bekjempes med å gruppere uttrykk som logisk sett høres sammen, ved å putte tomme linjer mellom gruppene. Det blir på denne måten også lettere å dokumentere kildekoden, siden man man kan enkelt se hvilken bit kode en kommentar hører til.

Whitespaces

Det må være en balanse mellom kildekode og tomrommene i en kildekode-fil. For lite tomrom gir mindre filer men kildekoden kan bli nærmest umulig å lese, og det motsatte er også tilfelle. For mye "luft" gjør det vanskelig å skjønne sammenhengene. Det er foreslått at man alltid skal ha mellomrom rundt matematiske operatorer og etter kommaer i lister.