LINUXSOFT.cz Přeskoč levou lištu
Uživatel: Heslo:  
   CZUKPL

> PHP (62) - Rozsáhlejší projekty 3.

Jak se neztratit v proměnných, konstantách, souborech, třídách a projektech. Jde to vůbec?

29.10.2004 15:00 | Petr Zajíc | Články autora | přečteno 28754×

Komerční sdělení: Pořádáme Kurzy PHP

Dnes budeme pokračovat zcela v duchu minulých dvou dílů a rozebereme si další způsoby, jak se neztratit při psaní nějakého rozsáhlejšího projektu. Nebudou to věci překvapivě nové, ale věci překvapivě účinné, pokud se rozhodnete řídit se jimi.

Komentáře

Kvalitní kód je zcela vždy dokumentovaný kód. Paradoxně zjistíte, že když budete programovat delší dobu, budete psát spíše více komentářů než méně. To proto, že zralí programátoři jsou si vědomi potřebného psaní komentářů velmi dobře (věřte mi, každý z nich totiž zažil fázi, kdy se nevyznal ani ve svém vlastním projektu). Co by měly správné komentáře obsahovat?

  • U funkcí okomentujte, co musí být splněno, aby vracela to, co má. Mohou to být "vnější" vlivy, jako je existující připojení k databázi, existující rozšíření PHP a kdovíco ještě.
  • U funkcí okomentujte vstupní parametry. Měl by mít parametr nějaký konkrétní typ? Hodnotu? Hodnotu z nějakého rozsahu? Napište si to. Později to zcela jistě oceníte.
  • U funkcí okomentujte hodnoty, které může vrátit, a jejich význam. Je hrozné mít funkci, která sice dělá to, co by měla, ale nikdo neví, proč to bylo potřeba.
  • U tříd nějak okomentujte parametry. Snažte se rozlišit veřejné a privátní členy, protože PHP je v tom dosti benevolentní.
  • V těle programu komentujte kód vždy, když je principiálně nepřehledný. Usnandí vám to orientaci.
  • Pokud jste nějakou část kódu přepsali, je lepší tu původní zakomentovat než odstranit. Později se Vám může stará verze hodit.

Pozn.: Ten poslední bod by se měl brát s rezervou. Stejnou, ne-li lepší službu pro nás udělají systémy pro správu zdrojových kódů. Ještě o nich bude řeč.

Někteří programátoři doporučují do poznámek psát rovněž datumy, kdy se kód upravoval a některé další věci. Je to diskutabilní. Pokud je to pro Vás přínosné, udělejte to.

Ještě pro doplnění: Některé čtenáře nadzvedlo, že jsem v předchozím díle komentoval činnost procedury v jejím těle a ne před jejím začátkem. Uvědomte si ale, že je mnohem důležitější to, zda komentáře máte než to, kde je máte. Budete-li chtít přístup k psaní komentářů nějak unifikovat, mohou rozhodnout následující činitele:

  • Vaše zvyky
  • To, zda se chcete nebo musíte řídit nějakými konvencemi (například firemními)
  • To, zda chcete nebo musíte používat nějaké nástroje pro automatizovanou dokumentaci

Typové konvence

Už o tom rovněž byla řeč. Měli byste si zavést a dodržovat určitý pořádek v názvech proměnných, funkcí, tříd, konstant a souborů. Náhledů jak to dělat správně je mnoho. Pamatujte si, že většinou se budete na linuxovém prostředí setkávat s tím, že na velikosti písmen bude záležet, takže s tím počítejte. Někdo například názvy všech souborů píše s malými písmeny.

Určitý systém lze vnést i do proměnných. Praktické je, když je z názvu proměnné poznat k čemu slouží (nebo dokonce jaký je její datový typ). Srovnejte, prosím, následující dva řádky kódu (třeba přitom můžete zavzpomínat na školní léta):

<?      
  $c
=$z*$p;
?>

anebo je čitelnější toto?

<?      
  $dblCast
=$intZaklad*$dblPocet_procent;
?>

Samozřejmě, se vzrůstající náročností kódu oceníte takovou čitelnost ještě více. Hodně se dá napravit rovněž vhodným zavedením konstant a logickými názvy souborů. Porovnejte, prosím, následující dva fragmenty kódu:

<?      
if ($err==1):
  require (
"file.php");
elseif (
$err==2):
  require (
"file2.php");
elseif (
$err==3):
  require (
"file3.php");
endif;
?>

anebo

<?      
define
("ERR_NO_FILE", 1);
define ("ERR_EMPTY_FILE", 2);
define ("ERR_CANT_WRITE", 3);

if (
$err==ERR_NO_FILE):
  require (
"nofile.php");
elseif (
$err==ERR_EMPTY_FILE):
  require (
"emptyfile.php");
elseif (
$err==ERR_CANT_WRITE):
  require (
"cantwrite.php");
endif;
?>

Ačkoli oba kousky kódu dělají v podstatě totéž - ke kterému z nich byste se raději vraceli a luštili, co se v něm vlastně děje?

Organizace projektu

Mám na mysli organizaci kódu do souborů a složek operačního systému. Tady je každá rada drahá. U jednodušších věcí asi vystačíte s tím, že můžete všechny skripty umístit do kořenové složky webu, u složitějších projektů se vyplatí nějak zorganizovat složky. Například bývá často k vidění uspořádání, kde soubory začlenění jsou v samostatné složce, v jiné složce soubory pro import/export a podobně. Pozor pak musíte dávat při vkládání soubrů pomocí include(require), protože vyžadují správné uvádění cest. Můžete v zásadě použít dvě metody - uvádět relativně od existujícího dokumentu a uvádět relativně od kořenové složky webu. Obojí má své pro a proti, ale příliš se nevyplácí to míchat:

<?      
  
require ("./inc/somefile.php");
?>

a ten druhý způsob

<?      
  
require ($_SERVER["DOCUMENT_ROOT"]."/inc/somefile.php");
?>

Pochopitelně, můžete mít nějaký vlastní systém. Ale ve větším projektu se vkládání souborů prakticky nevyhnete, takže se s tím budete muset nakonec nějak popasovat.

Dokumentace

Konečně, každý projekt by měl mít nějakou dokumentaci. Nemluvím teď o dokumentaci k vlastní aplikaci, ale o technické specifikaci jednotlivých funkcí a procedur. Tady se vývojáři dělí na několik typů:

  • na ty, kteří to nepíší vůbec
  • na ty, kteří to píší částečně nebo jen u větších věcí
  • a na ty, kteří to dělají ze zvyku a poměrně pravidelně

Zejména těmu ukázněným pak mohou pomocí nástroje typu phpDocumentor. My se spokojíme s tvrzením, že by se to dělat mělo a v dalším díle se podívame na to, jak si při vývoji pomoci cizími kódy, nástroji pro správu zdrojových kódů a několika programovacími triky.

Verze pro tisk

pridej.cz

 

DISKUZE

Nejsou žádné diskuzní příspěvky u dané položky.



Příspívat do diskuze mohou pouze registrovaní uživatelé.
> Vyhledávání software
> Vyhledávání článků

15.5.2017 23:50 /František Kučera
Máš rád svobodný software a hardware nebo se o nich chceš něco dozvědět? Zajímá tě DIY, CNC, SDR nebo morseovka? Přijď na sraz spolku OpenAlt, který se bude konat ve čtvrtek 18. května od 18:00 v Radegastovně Perón (Stroupežnického 20, Praha 5).
Přidat komentář

12.5.2017 16:42 /Honza Javorek
PyCon CZ, česká konference o programovacím jazyce Python, se po dvou úspěšných ročnících v Brně bude letos konat v Praze, a to 8. až 10. června. Na konferenci letos zavítá např. i Armin Ronacher, známý především jako autor frameworku Flask, šablon Jinja2/Twig, a dalších projektů. Těšit se můžete na přednášky o datové analytice, tvorbě webu, testování, tvorbě API, učení a mentorování programování, přednášky o rozvoji komunity, o použití Pythonu ve vědě nebo k ovládání nejrůznějších zařízení (MicroPython). Na vlastní prsty si můžete na workshopech vyzkoušet postavit Pythonem ovládaného robota, naučit se učit šestileté děti programovat, efektivně testovat nebo si v Pythonu pohrát s kartografickým materiálem. Kupujte lístky, dokud jsou.
Přidat komentář

2.5.2017 9:20 /Eva Rázgová
Putovní konference československé Drupal komunity "DrupalCamp Československo" se tentokrát koná 27. 5.2017 na VUT FIT v Brně. Můžete načerpat a vyměnit si zkušenosti z oblasti Drupalu 7 a 8, UX, SEO, managementu týmového vývoje, využití Dockeru pro Drupal a dalších. Vítáni jsou nováčci i experti. Akci pořádají Slovenská Drupal Asociácia a česká Asociace pro Drupal. Registrace na webu .
Přidat komentář

1.5.2017 20:31 /Pavel `Goldenfish' Kysilka
PR: 25.5.2017 proběhne v Praze konference na téma Firemní informační systémy. Hlavními tématy jsou: Informační systémy s vlastní inteligencí, efektivní práce s dokumenty, mobilní přístup k datům nebo využívání cloudu.
Přidat komentář

15.4.2017 15:20 /František Kučera
Máš rád svobodný software a hardware nebo se o nich chceš něco dozvědět? Zajímá tě IoT a radiokomunikace? Přijď na sraz spolku OpenAlt, který se bude konat ve středu 19. dubna od 18:30 v Šenkovně (Sokolská 60, Praha 2).
Přidat komentář

5.3.2017 19:12 /Redakce Linuxsoft.cz
PR: 23. března proběhne v Praze konferenci na téma Cloud computing v praxi. Hlavními tématy jsou: Nejžhavější trendy v oblasti cloudu a cloudových řešení, Moderní cloudové služby, Infrastruktura současných cloudů, Efektivní využití cloudu, Nástrahy cloudových řešení a jak se jim vyhnout.
Přidat komentář

27.2.2017 22:12 /František Kučera
Pozvánka na 137. sraz OpenAlt – Praha: Tentokrát jsme si pro vás připravili neobvyklou akci. Ve středu 1.3. v 17:30 nás přivítá sdružení CZ.NIC ve svých prostorách v Milešovské ulici číslo 5 na Praze 3, kde si pro nás připravili krátkou prezentaci jejich činnosti. Následně navštívíme jejich datacentrum pod Žižkovskou věží. Provedou nás prostory, které jsou běžnému smrtelníkovi nedostupné!
Po ukončení prohlídky se všchni odebereme do hostince U vodoucha, Jagelonská 21, Praha 3 pochutnat si na některém z vybraných piv či dát si něco na zub. Rezervaci máme od 19:30, heslo je OpenAlt.
Ale pozor! Do prostor datového centra máme omezený přístup, dostane se tam pouze 10 lidí! Takže kdo přijde dříve, ten má přednost, a občanky s sebou! Kdo nebude chtít na prohlídku datového centra, může se pomalu přesunout do hostince U vodoucha a u nepřeberné nabídky piv počkat na ostatní.
Přidat komentář

18.1.2017 0:49 /František Kučera
Členové a příznivci spolku OpenAlt se pravidelně schází v Praze a Brně. Fotky z pražských srazů za uplynulý rok si můžete prohlédnout na stránkách spolku. Příští sraz se koná už 19. ledna – tentokrát je tématem ergonomie ovládání počítače – tzn. klávesnice, myši a další zařízení. Také budete mít příležitost si prohlédnout pražský hackerspace Brmlab.
Přidat komentář

   Více ...   Přidat zprávičku

> Poslední diskuze

15.6.2017 9:34 / Ondřej Havlas
php,

10.6.2017 10:39 / Temple
sell home for cash

11.5.2017 23:32 / lelo
Re: Problém se správcem balíčků

11.5.2017 5:45 / davd mašek
Re: Problém se správcem balíčků

10.5.2017 22:54 / lelo
Re: Problém se správcem balíčků

Více ...

ISSN 1801-3805 | Provozovatel: Pavel Kysilka, IČ: 72868490 (2003-2017) | mail at linuxsoft dot cz | Design: www.megadesign.cz | Textová verze