/**
 * get number of all rows in table
 * @return Integer
 */

/**
 * set name of the Author
 * @param String
 */

// komentář – zakomentuje pouze kód na daném řádku
# komentář – zakomentuje pouze kód na daném řádku
/* komentář – všechno, co se nachází mezi tímto je bráno jako komentář */

if ($a > $b) echo „a je větší než b“;

if ($b > $c) {
        print „b je větší než c“;
}

if ($a > $b) {
        echo “a je vetší než b”;
}
else {
        echo “b je větší než a”;
}

nebo něco podobného odsazujte tabelátorem. Zajistíte si tím větší čítelnost kódu. Na první pohled zjistíte, kde vám začíná a kde vám končí podmínka, kde vám začína a končí vnořená podmínka atd.

if ($a > $b) {
if ($b > $c) {
echo “a je větší než b a zároveň b je větší než c”;
}
else{
echo “a je větší než b a zároveň b je menší než c”;
}
}

Naprosto nepřehledný až „hnusný kód“. Nejde v něm na první pohled vídět jestli tam je vnořená podmínka nebo ne a co se skrývá uvnitř podmínky.

if ($a > $b) {
        if ($b > $c) {
                echo “a je větší než b a zároveň b je větší než c”;
        }
        else{
                echo “a je větší než b a zároveň b je menší než c”;
        }
}

Nádherně čitelný kód. Na první pohled je zřetelné, že se jedná podmínku a v ní je obsažená další podmínka. Taky jde poznat, kde je začátek podmínky a kde její konec.

Ve vývojových prostředích taky bývá funkce tzv. „autoformátování“, která vám označený kód pěkně uspořádá. V eclipsu to je „ctrl + shift + f“, ovšem musíte míto označený text, který chcete naformátovat.

Buďte líní!

Možná si říkáte proč bych měl být líný? Vždyť pak nic nenaprogramuju. Opak je ale pravdou. Správný programátor by měl být líný, ale pouze do určité míry, hned vysvětlím proč. Máte kód, který píšete pořád a pořád dokola. Programátor, který není dostatečně líný bude psát znovu a znovu ten samý kód, avšak programátor který je líný a nechce se mu psát pořad stejný kód si napíše funkci, ve které bude obsažená opakující se část kódu a bude volat jenom danou funkci. S tímto je taký vzpjata tzv. „Obecnost“ neboli generalizace. Snažte se co nejvíce zobecnit funkce nebo celé Třídy. Čím větší obecnost, tím větší je šance znovupoužit váš kód.

Nevypisujte něco přímo pomocí echo „tohle se zobrazí na stránce“ nebo alespoň se o to pokuste. Zachovejte rozdělení aplikace na 3 vrstvy:

• prezentační
• logickou
• databáze

Zajistíte si tím lehčí opravování kódu a větší přehlednost. Ještě jedna věc na závěr k tomuto tématu. Snažte se používat zkratky „ctrl + c“ a „ctrl + v“ co nejméně. Myslím, že mi každý dá za pravdu, kolik zbytečných chyb se nadělá používáním těchto zkratek a kolik času potom ztrávíte hledáním chyb. Je to způsobeno tím, že na první pohled vypadá určitý kód podobně, tak proč ho nezkopírovat. Jenomže často se stává, že zapomenete pozměnit proměnnou, nebo hodnotu a chyba je na světě. V nejhorším případě je zkopírován kód, který je sám o sobě chybný a je používán na více místech, nakonec se však může zjisti, že kód je špatný a aje třeba dohledávat, kde všude byl zkopírován a opravit chyby.

Pokud možno pište veškerý kód i komentáře anglicky!

Říkám to hned z několika důvodu. Anglicky rozumí většina lidí na Zemi aproto můžete požádat o pomoc téměř kohokoli, jenom mu pastnete kód a bude vědet o co se jedná. Těžko však bude nějaký angličan rozumět česky napsanému kódu a asi těžko vám poradím. Mám s tím velké zkušenosti z práce. Dostáváme kód napsaný v céčku a s finskými komentáři a finskými proměnnými. Nikomu to fakt nepřeju, potom nemáte ani tušení co jaká proměnná znamená a k čemu slouží některé funkce. Další výhodou je to, že se nemusíte starat o gramatiku (háčky, čárky) v názvech proměnných a třídach. Např. taková třída „Animal“ zní rozhodně lépe než „Zvire“ ?. Anglicky napsaný kód se lépe „prodává“. Z těchto důvodů se budu snažit psát veškerý kód a komentáře anglicky.

Smysluplně pojmenovávejte vaše proměnné!

Občas je obtížné najít ten správný název pro danou proměnnou a mnohdy to skončí pojmenováním jako je třeba $a, $neco, $pokus, $test nebo i hůř ?. Rozhodně je lepší mít název proměnné delší, než vytvořit kratičký název proměnné, kdy v pozdější fázi nepochopíme o co se vlastně jedná. Pokud se název proměnné skládá z více než jednoho slova můžete buď napsat:

$nazevPromenne – první písmeno prvního slova bude malým písmenem, a vždycky další slovo bude začínat velkým písmenem

$nazev_promenne – jednotlivá slova oddělit podtržítkem

Názvy proměnných a fukncí by měly začínat malým písmenem. To naopak název třídy musí začínat velkým písmenem.

Logické datové typy a metody by měly začínat slovesem:
$isActive;
$hasAttribute;
$isInDB;
public static function isActive() { }
public function hasAttribute() { }…

Vyhněte se tzv. „Božským třídám“ !

Co to znamená? To jsou Třídy, které dělají téměř všechno i to, co by neměli dělat. Každá třídá má plnit svoji roli a né role navíc. Vemte si například taková třída pro načítání dat z databáze by měla mít za úkol pouze načítat data. Pokud nastane situace, že daná třída taky zobrazuje načtené data, pak je to špatně a už se třída blíží směrem k božské třídě.