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 29520×

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ů

18.6.2018 0:43 /František Kučera
Červnový pražský sraz spolku OpenAlt se koná již tento čtvrtek – 21. 6. 2018 od 18:00 v Kavárně Ideál (Sázavská 30, Praha), kde máme rezervovaný salonek. Tentokrát na téma: F-Droid, aneb svobodný software do vašeho mobilu. Kromě toho budou k vidění i vývojové desky HiFive1 se svobodným/otevřeným čipem RISC-V.
Přidat komentář

23.5.2018 20:55 /Ondřej Čečák
Od pátku 25.5. proběhne na Fakultě informačních technologií ČVUT v Praze openSUSE Conference. Můžete se těšit na spostu zajímavých přednášek, workshopů a také na Release Party nového openSUSE leap 15.0. V na stejném místě proběhne v sobotu 26.5. i seminář o bezpečnosti CryptoFest.
Přidat komentář

20.5.2018 17:45 /Redakce Linuxsoft.cz
Ve čtvrtek 31. května 2018 připravuje webový magazín BusinessIT ve spolupráci s Best Online Média s.r.o. pátý ročník odborné konference Firemní informační systémy 2018. Akce proběhne v kongresovém centru Vavruška (palác Charitas), Karlovo náměstí 5, Praha 2 (u metra Karlovo náměstí) od 9:00 hod. dopoledne do cca 15 hod. odpoledne. Konference je zaměřena na efektivní využití firemních informačních systémů a na to, jak plně využít jejich potenciál. Podrobnější informace na webových stránkách konfrence.
Přidat komentář

14.5.2018 7:28 /František Kučera
Květnový pražský sraz spolku OpenAlt se koná již tento čtvrtek – 17. 5. 2018 od 18:00 v Kavárně Ideál (Sázavská 30, Praha), kde máme rezervovaný salonek. Tentokrát na téma: Audio – zvuk v GNU/Linuxu.
Přidat komentář

7.5.2018 16:20 /František Kučera
Na stránkách spolku OpenAlt vyšla fotoreportáž Pražské srazy 2017 dokumentující srazy za uplynulý rok. Květnový pražský sraz na téma audio se bude konat 17. 5. 2018 (místo a čas ještě upřesníme).
Přidat komentář

17.4.2018 0:46 /František Kučera
Dubnový pražský sraz spolku OpenAlt se koná již tento čtvrtek – 19. 4. 2018 od 18:00 v Kavárně Ideál (Sázavská 30, Praha), kde máme rezervovaný salonek. Tématem tohoto srazu bude OpenStreetMap (OSM) aneb svobodné mapy.
Přidat komentář

16.3.2018 22:01 /František Kučera
Kulatý OpenAlt sraz v Praze oslavíme klasicky: u limonády a piva! Přijďte si posedět, dát si dobré jídlo a vybrat z mnoha piv do restaurace Kulový blesk, který najdete v centru Prahy nedaleko metra I. P. Pavlova na adrese Sokolská 13, Praha 2. Sraz se koná ve čtvrtek 22. března a začínáme v 18:00. Heslo: OpenAlt. Vezměte s sebou svoje hračky! Uvítáme, když si s sebou na sraz vezmete svoje oblíbené hračky. Jestli máte nějaký drobný projekt postavený na Arduinu, nějakou zajímavou elektronickou součástku, či třeba i pěkný úlovek z crowdfundingové akce, neváhejte. Oslníte ostatní a o zábavu bude postaráno.
Přidat komentář

13.2.2018 0:41 /František Kučera
Únorový pražský sraz OpenAltu se koná 15. 2. 2018 a tentokrát se vydáme na návštěvu do jednoho pražského datacentra. Sejdeme se v 17:50 v severovýchodní části nástupiště tramvajové zastávky Koh-I-Noor. Po exkurzi se přesuneme do restaurace U Pštrosa (Moskevská 49), kde probereme tradiční témata (svobodný software a hardware, DIY, CNC, SDR, 3D tisk…) a tentokrát bude k vidění i IoT brána od The Things Network.
Přidat komentář

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

> Poslední diskuze

20.2.2018 18:48 / Ivan Majer
portal

20.2.2018 15:57 / Jan Havel
Jak využíváte služby cloudu v podnikání?

16.1.2018 1:08 / Ivan Pittner
verejna ip od o2 ubuntu

15.1.2018 17:26 / Mira Harvalik
Re: Jak udělat HTML/Javascript swiping gallery do mobilu?

30.12.2017 20:16 / Michal Knoll
odmocnina

Více ...

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