Koodi vormistamisest

  1. Üliõpilastööna vormistatud programmides tuleb kasutada eesti keelt (kommentaarid, identifikaatorid jne.), kui eesti keelt ei osata piisavalt, siis ortograafiavead on aktsepteeritavad (NB! nõue aegunud alates 2006/2007 õppeaastast). Inglise vm. keele kasutamine tuleb eraldi põhjendada ja kokku leppida.
  2. Võõra koodi kasutamine ilma autori  loata ja ammendava viiteta algallikale on lubamatu.
  3. Muutujate, meetodite, klasside, liideste, failide jt. objektide nimed tuleb valida nende kasutusotstarvet kirjeldavalt. Tsükliindeksite nimed, massiiviindeksite nimed jt. üldarusaadavad juhtumid võivad  erandina olla ühetähelised.
  4. Java klasside ja liideste nimed kirjutatakse suure algustähega, meetodite ja muutujate nimed väikese algustähega, konstantide nimedes on kõik tähed suured. Mitmesõnalistes identifikaatorites kirjutatakse sõnad alates teisest suure algustähega.
  5. Koodi treppimiseks kasutatakse tühikuid, soovitatav (minimaalne) treppimissamm on kaks kuni neli tühikut (Google koodistiil näeb ette kaks tühikut). Trepitakse kõik juhtimisstruktuurid, klassi sisu klassi päise suhtes, meetodi sisu meetodi päise suhtes. Tabulaatori abil treppimine toob kaasa probleeme lähteteksti viimisel ühelt platvormilt/toimetilt teisele (see on lubatrud juhul, kui mitte mingisugust ülekantavust ei ole vaja).
  6.  Loogeline avav sulg kirjutatakse reeglina rea lõppu, vastav sulgev sulg on joondatud selle rea alguse järgi. Näit:
if (tingimus()) {
lause;
} else {
teinelause;
}

Klassi, liidese ja meetodi lõpusulu järele on hea kommentaarina  kirjutada selle üksuse nimi, mida see sulg lõpetab. Seda võib kasutada ka juhtimisstruktuuride juures, kui sisu on pikk ja sulud raskesti jälgitavad.

  1. Meetodi nime ja parameetrite loetelu vahel võib olla tühik, kui see loetelu pole tühi; tühja loetelu ette tühikut ei panda. Sama reegel kehtib ka massiiviindeksite kohta.
 Näit.
objekt.toString();
Math.sin (PI/4.);
  1. Javadoc-kommentaarid on vajalikud järgmiste elementide juures:
  1. Meetodite vahele jäetakse tühi rida. Kui samas failis on mitu klassi või liidest (reeglina ei peaks sellist olukorda tekkima), siis nende vahele jäetakse vähemalt üks tühi rida. Tühje ridu võib loetavuse parandamiseks vabalt kasutada.
  2.  Koma (ka semikooloni) järele jäetakse tühik. Unaarsete operaatorite ja operandi vahele tühikut ei jäeta.

  Oracle'i Java koodistandard vastab siin vastamata küsimustele, aga uurige ka uuemaid.

Jaanus Pöial