Administrace komentářů

Nauč se používat třídy a autoloader. Hlavním přínosem tříd je zapouzdření kódu. Autoloader za tebe vyřeší includy. Jestli budeš mít o include víc nebo míň neřeš, dokud nebudeš mít pořádný důvod proč, neboť pak i budeš vědět jak.

Do jednoho souboru dej jednu třídu. Jedna třída reprezentuje jednu věc. Jedna metoda dělá jeden úkol a je fajn, když se vejde na jednu stránku (obrazovku).

Úkol, který metoda řeší by měl být popsán v komentáři před její hlavičkou a tento popis by se měl vejít do jedné nebo dvou vět. Pokud ti dvě věty nestačí, rozděl to na více metod.

Důležitá je dokumentace. Nauč se používat (např.) doxygen a komentuj tak, aby tomu rozuměl (jde jen o styl psaní komentářů).

Kód by měl být napsán tak, aby komentáře nepotřeboval. Tedy v první řadě přehledně a srozumitelně, v druhé řadě správně a až potom teprve efektivně. Pokud je kód srozumitelný a chybný, lze ho opravit. Pokud ale je správný a nesrozumitelný, nevíš, že je opravdu správně a nelze ho rozšířit ani znovu použít. Viz Worse is Better. Pokud je kód příliš pomalý, obvykle je třeba zvolit lepší algoritmus, příležitostné optimalizace to nezachrání.

S tím souvisí i verzování. Když něco uděláš, udělej commit a dej mu smysluplný popis. Nejde ani tak o historii nebo sdílení kódu, ale o to, že budeš schopný pojmenovat provedenou změnu v kódu a díky tomu se ti bude lépe udržovat pořádek, jak program poroste. Doporučuju Git, neboť se nemusíš zatěžovat umístěním repositáře.

Přehlednosti pomůže, když je kód psaný všude stejným stylem. To se týká pojmenování proměnných a metod, tříd, a formátování. Zvol si automatický formátovač kódu (např. indent -kr -i8 -l120 – pozor, neumí PHP) a přijmi jeho styl za svůj. Pokud ti někdo pošle blbě zformátovaný patch, bude snadné ho upravit, aby ladil s okolním kódem. Obdobně když budeš s někým potřebovat spolupracovat.