počítače

Jak přidat komentáře k vašemu PHP programu

Leden 2021

Každý programátor má názor na to, jaké informace by měly být obsaženy v programovém kódu. Většina programátorů přidává ke svému kódu komentáře, aby si připomněla sobě a komukoli jinému, co kód dělá a jak to dělá. Při rozhodování o tom, jaké informace se mají zahrnout, se zeptejte sami sebe, co byste měli o programu vědět, pokud někdo program napsal a nyní jste byli požádáni o jeho spuštění a údržbu.

Většina programů, které píšete, bude mít více než jednu stránku kódu. Každá stránka kódu bude uložena jako programový soubor PHP. (filename.php3) V programovém souboru jsou dvě místa, kam budete chtít přidat nějaké informační komentáře.

V horní části každého programového souboru budete uvádět obecné informace o programu.
- V horní části souboru a hned za otevírací značku PHP umístíte název souboru, například HelloWorld.php3.
- Dále přidáte oznámení o autorských právech, které pojmenujete sebe jako vlastníka autorských práv programu.
- Pokud bude mít váš program více než jednu stránku kódu, uvedete, že se jedná o jednu stránku většího programu a zadejte název tohoto programu.
- Budete také chtít zahrnout stručný popis účelu programu a jeho fungování.
- Nakonec přidáte jakékoli informace o vyloučení odpovědnosti a licencích. Může to být například licence napsaná vaším právníkem nebo GNU General Public License, kterou můžete volně používat v kterémkoli z vašich freewarových programů. Kopii této licence si můžete stáhnout z webu Free Software Foundation. Budeme o tom diskutovat podrobněji v samostatném tutoriálu.
Druhá oblast, do které chcete přidat komentáře, je celý kód samotný na začátku každé hlavní části kódu. Uveďte krátký komentář o tom, jaký úkol bude daný oddíl provádět.

Existují tři způsoby, jak přidat komentáře do programového kódu.

// komentáře najdete zde

Toto je základní komentář ve stylu PHP. Všechno na stejném řádku, které přijde po dvou //, bude server ignorováno a nebude zpracováno jako programový kód.

# komentáře najdete zde

Toto je komentář ve stylu shellu. Všechno na stejném řádku, které přichází po #, bude server ignorováno a nebude zpracováno jako programový kód.

/*
komentáře jdou sem
komentáře jdou sem
komentáře jdou sem
*/

Toto je komentář ve stylu C. Server, který bude mezi úvodním / * a závěrečným * /, bude ignorován a nebude zpracován jako programový kód. Tento styl můžete použít, pokud máte více než jeden řádek komentářů, jak jsme diskutovali v tomto tutoriálu. Klikněte zde pro příklad.