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 domunetu Java Code Conventions (viz. sekce Literatura)

Třídy a rozhraní (interface)

  • Název obsahuje podstatná 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:
  1. Komentář - dokumentační popis třídy
  2. Dekladace třídy nebo rozhraní
  3. Komentář - informace o vnitřní implementaci třídy, pokud je to nutné
  4. Statické proměnné
  5. Instanční proměnné
  6. Konstruktory
  7. 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

  • Konstanty se pojmenovávají výhradně velkými písmeny
  • Jednostlivá slova se oddělují podtržítkem “_”

int MAX_VELIKOST = 155;

Ostatní

  • Nedělejte mezeru mezi názvem metody a závorkou s parametru
  • Používejte odsazování jednotlivých bloků kódu. Zlepšíte tím čitelnost kódu.

Literatura

Jedna z nejucelenějších publikací na téma správného kódování od tvůrců Javy: Oracle - Java Code Conventions, 1997

courses/bd6b36pjv/vstupni_znalosti/zal/konvence.txt · Last modified: 2018/01/17 16:43 (external edit)