Čtvrtý díl o PHP – Komentáře

V minulých dílech jsme si tedy vysvětlili, jak se PHP zapisuje a jak vypsat řetězec. Nyní se podíváme na jednu důležitou část, tou jsou komentáře.

Pokud budete tvořit velmi jednoduchý projekt, jistě si řeknete, že je nepotřebujete, prosím Vás, naučte se kusy kódu si popisovat. Když teď napíšete kus kódu, pamatovat si jej budete, nicméně třeba za rok to tak již být nemusí a tak se v kódu ztratíte, zvlášť, pokud se v kódu dopustíte nějaké „prasárny“. Z tohoto důvodu zmiňuji komentáře takto na začátku, nyní si tedy ukážeme, jak je používat a jak okomentovat náš kód z minulého dílu.

Komentáře dělíme do dvou skupin, tou první jsou komentáře jednořádkové, ta druhá skupina jsou komentáře víceřádkové, ale vezmeme vše postupně.

Jednořádkové komentáře zapisujeme jako dvě dopředná lomítka za sebou, tedy „//“ v kódu to můžeme vidět třeba takto:

<?php

//náš komentář

echo „výpis prvních čtyrech slov“;

?>

Vytvářet komentář je tedy vhodné před tím, než začne nějaká instrukce a do komentáře si popsat, co dělá. V případě takto jednoduchého řetězce je to však jedno a komentář je zbytečný, když to přesně vidíme, nicméně až budeme získávat data třeba z databáze, už to tak jednoznačné nebude.

Dalším způsobem, jak v PHP zapsat jednořádkový komentář je mřížka, tedy #, uvedeme si stejný příklad jako v případě s lomítky.

<?php

#náš komentář

echo „výpis prvních čtyrech slov“;

?>

To, jak budete komentáře využívat je na Vás, já však preferuji variantu se dvěma dopřednými lomítky.

Nyní se podíváme na víceřádkové komentáře. Pro víceřádkové komentáře se používá dvojice znaků a to /* a */

<?php

/*

naš

víceřádkový

komentář

*/

echo „výpis prvních čtyrech slov“;

?>

Z kódu je tedy opět velmi dobře vidět, jak se víceřádkový komentář vytváří. Slouží například, pokud připisujete kus kódu, který zatím nefunguje a budete pokračovat třeba až zítra a nebo pokud aktuální kód používáte a to co dopisujete je pouze rozšíření toho stávajícího, nebo prostě jen pokud potřebujete komentovat opravdu velkým množstvím slov.

Na co si jistě dávejte pozor jsou vnořené komentáře, mějte na paměti, že pokud budete vnořovat komentáře do sebe, už první */ Vám komentář zruší a kód opět nebude funkční.

<?php

/*

naš

víceřádkový

komentář

/*

vnořený komentář

*/

*/

echo „výpis prvních čtyrech slov“;

?>

Takto se komentář nevytváří a vše skončí chybou.

„Líbil se Vám tento článek? Sdílejte ho prosím na sociálních sítích, ať se o něm dozvědí i Vaši kamarádi. Děkuji!“
Share on FacebookShare on Google+Tweet about this on TwitterShare on TumblrEmail this to someone