Jelenlegi hely

Utolsó változások

24.7. Elnevezési konvenciók

Az elnevezési konvenciók segítségével jobban olvasható programkódot kapunk. Már a név formája alapján lehet tudni, hogy konstans, csomagnév, osztály vagy változó.

24.6. Elválasztók

Az üres sorok logikailag tagolják, és így olvashatóbbá teszik a kódot.

Két üres sort alkalmazzunk osztályok elválasztására. Egy sor elegendő a következő esetekben:

  • Metódusok között
  • Változó deklarációk és a blokk első utasítása között
  • Blokk vagy egysoros megjegyzés előtt
  • A metódus logikai egységei között (jellemzően 3-10 soronként)

Üres szóközöket alkalmazunk a következő esetekben:

24.5. Utasítások

Egyszerű utasítások

Soronként csak egy utasítás szerepel:

argv++;       // Correct
argc--;       // Correct 
argv++; argc--;       // AVOID!

Összetett utasítások

Az összetett utasítás ’{’ és ’}’ között utasítások sorozatát tartalmazza. A tartalmazott utasítások egy közzel (4 szóközzel) bentebb kezdődnek, mint az összetett utasítás blokk.

Feltételes utasítások

Az if, if-else, if else-if else utasítások:

24.4.1 A deklaráció helye

A deklarációk a blokk legelején legyenek. Bár vannak érvek mellette, mégsem érdemes később, az első használat helyén deklarálni az azonosítókat. Ennek az lenne a hátránya, hogy akadályozná az érvényességi tartományon belüli hordozhatóságot.

void myMethod() {
    int int1 = 0;         // beginning of method block
    if (condition) {
        int int2 = 0;     // beginning of "if" block
        ...
    }
}

Az egyetlen logikus kivétel, amikor a for ciklusban hozzuk létre a ciklusváltozót:

24.4. Deklarációk

A könnyű kommentezhetőség (és a jobb átláthatóság) érdekében minden sor csak egy deklarációt tartalmaz:

int level; // indentation level
int size;  // size of table

Kevésbé javasolható:

int level, size;

Semmiképpen ne kerüljenek egy sorba különböző típusú deklarációk:

int foo,  fooarray[]; //WRONG!

A kód még könnyebben olvasható lesz, ha a típusok, azonosítók és megjegyzések táblázatszerűen tabuláltak:

24.3.1 Implementációs megjegyzések

A programok négyféle implementációs megjegyzést tartalmazhatnak: blokk, egysoros, nyomkövetési és sorvégi.

Blokk megjegyzések

A blokk megjegyzések leírást tartalmaznak a fájlhoz, metódushoz, adatszerkezethez vagy algoritmushoz. Fájl esetén a fájl elején, a többi esetben a metódus belsejében szokás elhelyezni, alkalmazkodva a megjegyzéssel ellátott egység behúzásához.

A blokk megjegyzés egy üres sorral kezdődik és fejeződik is be:

24.3. Megjegyzések

A Java programok kétféle megjegyzést alkalmaznak: dokumentációs és implementációs megjegyzést. Az utóbbi a C++ nyelvhez hasonló, míg az előbbi a Java specialitása. (Megjegyzés: Ezt a bevált ötletet a PHP is átvette.) A dokumentációs megjegyzés /** és */ közötti karaktersorozat. A javadoc segédprogram képes ez alapján automatikusan generálni HTML alapú, teljesen hipertext felépítésű dokumentációt.

24.2. Behúzás

Megjegyzés: Ebben a jegyzetben a nyomtatás speciális tördelése miatt néhol eltértünk a következő szabályoktól.

2 vagy 4 szóköz, vagy a tabulátor karakter használata célszerű.

A sorok hossza ne legyen több 80 karakternél. Bizonyos esetekben érdemes 70 karakterben maximálni a sor hosszát.

Hosszú sorok tördelése

Ha egy kifejezés nem fér el egy sorban, a következők alapján tördeljünk:

Oldalak