Jak správně pojmenovat uživatelské identifikátory?
Pojmenování čehokoli by mělo být co nejkratší, ale výstižné
Komentáře by měly být dobře viditelné a vhodně oddělené od funkčního kódu
Vyvarujte se řádkům delších než 70-80 znaků. V případě, že je kód delší, vhodně ho rozdělte na více řádků.
// ukázka dělení řádků
function(longExpression1, longExpression2, longExpression3,
longExpression4, longExpression5);
var = function1(longExpression1,
function2(longExpression2,
longExpression3));
Další ukázky vhodného zápisu kódu můžete najít v dokumentu Java Code Conventions (viz. sekce Literatura)
Třídy a rozhraní (interface)
Název obsahuje podstatná jména, rozhraní přídavná jména
Pokud název obsahuje více slov, je první písmeno každého (i prvního) slova velké, ostatní malá
Metody a proměnné nedeklarujte jako veřejné, pokud to není nutné
Udržujte vhodné pořadí deklarací metod a proměnných. Je doporučeno:
Komentář - dokumentační popis třídy
Dekladace třídy nebo rozhraní
Komentář - informace o vnitřní implementaci třídy, pokud je to nutné
Statické proměnné
Instanční proměnné
Konstruktory
Ostatní metody
Metody
Název obsahuje obvykle slovesa
První písmeno je vždy malé. Pokud je název víceslovný, je první písmeno každého slova velké (s výjimkou prvního)
void spustVykresleni() {
...
}
double[][] naplnNahodnePole(int velikostVertikalni, int velikostHorizontalni) {
...
}
Proměnné
Pojmenování malými písmeny, počáteční písmena vnitřních slov jsou velká
Důležitá je vhodnost pojmenování, aby nebylo třeba dlouho přemýšlet, co je v které proměnné uloženo
Názvý proměnných, které tvoří jen jedno písmeno používejte pouze pro řídící proměnné cyklů nebo dočasné proměnné!
int velikostPole;
double[] poleParametru;
Konstanty
final int MAX_VELIKOST = 155;
Ostatní
Nedělejte mezeru mezi názvem metody a závorkou s parametry.
Používejte odsazování jednotlivých bloků kódu. Zlepšíte tím čitelnost kódu.
Využívejte formátování v editoru - Idea → CTRL+ALT+SHIFT+L
Literatura