Information om kodningsstandarder
Jag har letat efter lämpliga kodningsstandarder för Java men de jag
har hittat är antingen urgamla eller onödigt komplicerade. Därför har
jag plockat ihop en lista av saker en nybörjare bör tänka på.
- Variabler, metoder och namn på paket skrivs med liten bokstav. Om
namnet består av flera ord skrivs orden ihop och de efterföljande
orden skrivs med stor bokstav, till exempel "ettEnkeltExempel".
- Namn på klasser och interface skrivs med stor bokstav. Om namnet
består av flera ord skrives orden ihop.
- Konstanter (dvs variabler deklarerade med
static final
) skrivs
med stora bokstäver. I en identifierare bestående av flera ord
separeras orden med '_'.
- Undvik svenska bokstäver i identifierare; det orsakar ofta problem
om man flyttar programmet mellan olika maskiner.
- Lägg varje klass i en egen fil. Om programmet är litet kan du
istället lägga hela programmet i en fil.
- Undvik tab-tecken i programkod.
- Bestäm en maximal längd för programrader. Jag brukar undvika rader
längre än 80 tecken.
Kommersiella standarder
Ta gärna en titt på de kommersiella kodstandarder för Java som jag
länkar till nedan. (Det finns fler.)
Sun/Oracle.
Google.
Github.
Frågor
Några frågor som det kan vara värt att fundera på:
- Vad är målet med kodstandarder?
- Uppnår man målet? Ge något argument för eller emot.
- Vad är kostnaden med kodstandarder?
- Hur skiljer sig de olika kodningsstandarderna/vad är de överens om?
- Ger jag något programexempel som inte följer min egen kodstandard?