Nedanstående tips är tagna från Java vett och etikett.
Observera att i vissa kodexempel från övningarna har jag blandat
engelska och svenska i metodnamn, till exempel getÅlder(). Detta är
inte att rekommendera. Använd hellre getAge(), hämtaÅlder() eller bara
ålder() som metodnamn.
Källkod är skriven av och för människor, och därför ska den
göras lättläst. Nedastående rekommendationer underlättar för läsaren
väsentligt och bör följas om man inte har mycket goda skäl till att
bryta mot dem.
- Använd alltid beskrivande namn på identifierare.
- Använd ett konsekvent språk för dina identifierare
(t e x att alltid använda svenska klass-, variabel- och
metodnamn).
- Följ befintlig praxis:
- Skriv Klasser med inledande STOR bokstav.
- Skriv variabler med inledande liten bokstav.
- Skriv metoder() med inledande liten
bokstav. Glöm inte heller metodparenteserna.
- Skriv namnSomBestårAvFleraOrd med STOR första bokstav i varje ord (utom första ordet).
- Undvik l (lilla 'L') och O (stora bokstaven).
- Indentera källkoden. I Emacs används
TAB-tangenten för att indentera aktuell rad. Gör detta uppifrån och
ned i programmet.
- Skriv luftigt. Utnyttja mellanslag mellan operatorer (som
t e x '+', '-', '*', '/' eller '=').
- Var konsekvent i ditt skrivsätt (t e x med var du
sätter mellanslag, kommentarer o s v).
Tillbaka till teaching-sidan
(email)
