Koodi vormistamisest

  1. Programmid peavad olema omalooming - võõra koodi kasutamine ilma otsese viite ja autori loata on keelatud ja viib eksmatrikuleerimiseni. Ülesande lahendamine valmis vastuste otsimise teel ei ole aktsepteeritav.
  2. Klasside ja liideste nimed kirjutatakse suure algustähega, meetodite ja muutujate nimed väikese algustähega, konstantide nimed suurtähtedega. Mitmesõnalistes identifikaatorites kirjutatakse sõnad alates teisest suure algustähega.
  3. Koodi treppimiseks kasutatakse tühikuid, soovitatav treppimissamm on kaks kuni neli tühikut (Google koodistiil näeb ette kaks).
  4.  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;
}
  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. 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.

Jaanus Pöial