Stilguide

Eftersom programkod inte bara skall läsas av kompilatorn utan också, i stor omfattning av människor, skall den utformas på ett enhetligt sätt som gör den så lättbegriplig som möjligt. Man skall alltså utnyttja indentering, radbrytning och blanktecken så att strukturen på programmet tydligt framgår. Observera att man hela tiden som man arbetar med programmet skall följa dessa konventioner. Programmeraren själv är ju den som mest läser programmet och en vettig struktur underlättar i hög grad förståelse och felsökning.

Det finns en officiell stilguide som man hittar på Suns Java-sidor: http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html.

• Radlängd Inga rader skall vara längre än 80 tecken! Ofta är det utskriftsrader med mycket text som som blir långa. Textsträngar kan brytas:
  

       System.out.println("Sjung o gudinna om vreden som brann hos peliden Akilles");
  

  kan skrivas

       System.out.println("Sjung o gudinna om vreden " +
                          "som brann hos peliden Akilles");
    

• Indentering Indenteringen dvs indragning av texten på raderna är oerhört viktig för den mänskliga förståelsen av programmet. Editorer ger ofta hjälp med att indenteringen. Stödet i BlueJ är inte särskilt avancerat men fullt tillräckligt för att få en vettig layout på programmet. BlueJ indenterar på klammerparenteserna så det är extra viktigt att man sätter ut dem konsekvent.
• Kommentarer Du kan förutsätta att läsaren av programmet kan Java. Skriv alltså inte kommentarer av typen

      i = i + 1;  // i ökas med 1
  

  (liknande kommentarer kan förekomma i kodexempel som vi delar ut vilket på att vi inte kan förutsätta att ni kan java...)
  Det är övergripande struktur och sådant som inte är uppenbart från koden som skall kommenteras.