Jak se vyznat ve složitějším kódu

Tento článek popisuje obecné metody, jak lze zpřehlednit delší kód. Hodí se to pro snadnou orientaci pro vás a ostatní lidi, kteří to po vás budou nuceni číst. Budu zde také uvádět nepsané pravidla, které je dobré dodržovat.

Všechny tyto metody a postupy jsou pro programátory a jejich pohodlí. Počítač je stroj, nevadí mu nepřehledný, neformátovaný dlouhý kód.

Poznámky

Poznámka nemá na samotný script vůbec žádný vliv. Při zpracování bude ignorována. Nebude jí vidět ani žádný návštěvník vaší stránky. Je čistě pro vás.

$a = 5; // poznámka k proměnné, jen na 1 řádek
// vnitřní poznámka, jen na 1 řádek
/* tato poznámka, může být libovolně dlouhá
na 2 řádky,

na 4 řádky, i více */
################

Odřádkování a grafické oddělení

Je dobré související části programu k sobě a oddělovat je do logických bloků. Pak je lze snadněji vyhledat, doplnit, upravit, … protože už budete vědět, kde jsou.

$a = 5;
$b = 3;
$c = 15;
################
$d = $c-$b+$a;
$e = $c+$b+$a;
################
echo $d;
echo $c;

V ukázce jsou jasně vidět 3 různé bloky, které dělají podobnou činnost a jsou si více podobné, než jiné. Celé to lze oddělit odřádkováním nebo mřížkou.

Dokumentační komentáře

Při delších scriptech, kde to hraničí mezi scriptem a programem, je dobré napsat něco jako „Dokumentační komentář“.

Příklad:

/**
* @author      jméno (email)
* @copyright   jméno datum
* @license     URL název (licence)
* @link        URL adresa
* @var         Typ popis (proměnné nebo vlastnosti)
* @package     název (balíčku)
*/

A další, je jich ještě přes 20…

Není to nikde nijak normalizováno a není to povinné. Jedná se ale o nepsané pravidlo a je fain se tím řídit. Využití nastvá zejména v případě, že vaše zdrojové kódy šíříte mezi další lidi.

Čeština VS. Angličtina

Pokud kód nepíšete jen pro sebe, tak je dobré vše psát v angličtině (zejména názvy proměnných). Angličtina je celosvětový jazykk a předpokládá se, že ho zná každý vývojář. Pokud budete váš kód šířit po internetu, tak je návštěva ze zahraničí poměrně pravděpodobná.

Pořadí násobení a dělení

Při matematických operacích vždy myslete na to, že je lepší napřed násobit a až pak dělit (dojde k menšímu zaokrouhlení). Může se totiž stát, že v mezi výpočtu vyjde desetinné číslo a pak může celý výsledek vyjít špatně (PHP přitozeně zaokrouhluje na 11 desetinných mís­t).

echo 10/3;

Tento příklad vám vypíše 3.33333333333. Nyní již ukážu konkrétní příklad se znaménky:

echo 1 / 2 * 2; // tohle je horší, protože 1/2 = 0.5*2 = 1
echo 2 * 1 / 2; // tohle je lepší, protože 2*1 = 2/2 = 1

V obou případech jsou mezi-výpočty, pokud by to byly větší čísla, tak je možné, že vyjde desetinné číslo a následně vyjdou oba výsledky jinak. Musíte se snažit znaménka napsat tak, aby vyšlo kladné číslo nebo co nejbližší ke kladnému.

Pokud jste zaběhlý vývojář a nebojíte se složité matematiky, tak můžete počítat ve zlomcích. Zlomky jsou fain, jsou přesné… ale složité a pomalé.

Sponzorované odkazy
Pomohl Vám tento článek?