Jelenlegi hely

24.1. Fájlok szervezése

Minden java forrásállomány egyetlen publikus osztályt vagy interfészt tartalmaz, de ezen túl tartalmazhat még privát, a forrásállományon kívül kapcsolattal nem rendelkező további osztályokat és interfészeket. A publikus típust javasolt először leírni. A publikus típus neve és a forrásfájl neve meg kell, hogy egyezzen, beleértve a kisbetű-nagybetű különbségét is.

A Java forrásállomány a következő elemeket tartalmazza:

  • Kezdő megjegyzés
  • Csomag és import kifejezések
  • Osztály és interfész deklarációk

Kezdő megjegyzés

Minden forrásállománynak kellene tartalmaznia egy C stílusú megjegyzést a (publikus) osztály nevével, verzió információival, dátummal és szerzői jogokkal:

/*
* Osztálynév
*
* Verzió információk
*
* Dátum
*
* Copyright
*/

Javasolt a hagyományos megjegyzés helyett/mellett dokumentációs megjegyzéseket is alkalmazni.

Csomag és import kifejezések

A megjegyzés utáni első nem üres sor a csomag kifejezés kell, hogy legyen. Azután következhetnek az import kifejezések:

package java.awt;
import java.awt.peer.CanvasPeer;

Megjegyzés: Az egyedi csomagnév első része csupa angol kisbetűből álló, fordított doménnév.

Osztály és interfész deklaráció

A következő táblázat összefoglalja az osztály és interfész deklaráció szabályait:

osztály vagy interfész dokumentációs megjegyzés (/**...*/)
osztály vagy interfész kifejezés
osztály vagy interfész megvalósítási megjegyzés (/*...*/), ha szükséges Ez a megjegyzés olyan információkat tartalmaz, amik csak a megvalósítás részleteiről szólnak, az osztály későbbi felhasználása során nem lesz szükség ezekre az információkra. Ilyen módon a dokumentációs megjegyzésbe nem kerül bele.
osztály (statikus) változók Először a publikus, majd védett, csomag szintű, és végül privát változók szerepeljenek.
példányváltozók Ugyanolyan láthatósági sorrendben, mint az osztályváltozók
konstruktorok
metódusok A metódusok feladat szerint és láthatóság szerint csoportosítva.