parametry: public/private (bez -pp neni v dokumentaci)/protected
@author
označit lze: cokoliv
parametry: jméno <e-mail>
@copyright
označit lze: cokoliv
dědí se od rodičovské třídy
@deprecated
označit lze: cokoliv kromě souboru
parametry: informace
význam: označuje zastaralé elementy, které se nedoporučují používat
@example
označit lze: soubor
význam: označuje soubor s příkladem
@final
označit lze: metody a třídy
význam: takto označené metody by se neměly překrývat v děděných třídách
@filesource
označit lze: soubor
význam: pokud se tag objeví v prvním DocBloku souboru, k dokumentaci v tomto souboru se přidá zdrojový text
@ignore
označit lze: cokoliv
význam: nebude se dokumentovat
@internal
označit lze: cokoliv
význam: poznámky, nebudou se dokumentovat
@license
označit lze: cokoliv
parametry: URL popis
@link
označit lze: cokoliv
parametry: URL popis
význam: odkaz na stránku, e-mail apod.
@package
označit lze: soubory a třídy
parametry: název
význam: řazení souborů a tříd do balíků pro lepší přehled
@param
označit lze: funkce a metody
parametry: datový_typ $proměnná popis
význam: dokumentování paramentrů funkce, když nemá proměnná typ, uvede se mixed
@return
označit lze: funkce a metody
parametry: datový_typ popis
význam: návratová hodnota fce, pokud neznáme, použijeme mixed
@see
označit lze: cokoliv
parametry: odkaz, odkaz, odkaz, ...
význam: odkazování na jakýkoliv popisovaný element v dokumentaci kromě include a require, $proměnná - odkaz na proměnnou ve stejné třídě, fce(), třída, třída::atribut, třída::metoda(), soubor.přípona - soubor se musí dokumentovat
POMOCÍ PHP_MANUAL#element přímo na webové stránky php s popisem elementu
@since
označit lze: cokoliv
parametry: verze/informace
význam: dokumentuje verzi souftware, od které je popisovaný element jeho součástí
@static
označit lze: třídy a metody
parametry: poznámky
význam: takto označené metody je možné volat přímo bez nutnosti vytvářet instance třídy
@staticvar
označit lze: funkce a metody
parametry: datový_typ popis
význam: pro fce mající deklarovány statické proměnné (jejichž hodnota se udržuje při celém běhu skriptu)
@subpackage
označit lze: soubory a třídy
parametry: název
význam: smysl pouze s tagem package, více subbalíků pak sdruženo do 1 balíku
@todo
označit lze: cokoliv
parametry: poznámky
význam: poznámka bude vypsána ve zvláštní sekci dokumentu
@uses
označit lze: cokoliv
parametry: odkaz popis_použití
význam: vytvoří odkaz i zpětný odkaz na element, který je v popisovaném nějak použit
@var
označit lze: atributy třídy
parametry: datový_typ popis
význam: popis atributu třídy, každý DocBlok může mít maximálně jeden tento tag
@version
označit lze: cokoliv
parametry: verze
význam: verze elementu, dědí se od rodičovské třídy
Inline tagy
ve tvaru {@tag neco} se pisi primo do kratkeho nebo dlouheho popisu v DocBloku
{@internal}}
označit lze: cokoliv
parametry: popis
význam: nebude vidět v dokumentaci, pouze s -pp, musi koncit 2 složenými závorkami
{@inheritdoc}
označit lze: odděděné třídy
význam: u třídy potomka bude nahrazen jeho dlouhým popisem rodičovské třídy, musí být umístěn ve dlouhém popisu, automaticky se dědí autor, copyright, licence
{@link}
označit lze: cokoliv
parametry: url popis / element popis
význam: kdekoliv v DocBloku uvést odkaz na element z dokumentace nebo URL
{@source}
označit lze: funkce a metody
parametry: 1.řádek počet_řádků
význam: je nahrazen výpisem zdrojáku popisované fce, bez parametrů se vypíše celá
Základy
nástroj, kterým automaticky vytváří dokumentaci php programu z komentářů
DocBlok
/**
* kratky popis
*
* dlouhy popis
*/
Krátký popis končí buď za větou nebo prázdnou řádkou, max na 3 řádky, pokud delší bere se pouze 1. a zbytek se považuje za dlouhý popis
Dlouhý popis je libovolně dlouhý, nepovinný, na konci může být seznam tagů, může obsahovat odstavce (prázdné řádky nebo přímo <p>)
HTML tagy v DocBloku
<b>, <code>, <br>, <i>
<kbd> - vstup z klávesnice/výpis na obrazovce
<ul>, <ol>, <li>, <p>
<pre> - ponechává všechny bílé znaky
<samp> - příklad nebo vzor
<vat> - název proměnné
Řídící značky jako text
<code> => <<code>>
*/ => {@*}
Seznamy
/**
* necislovany seznam
* - prvni
* - druhy
*/
lze použít -, + nebo #
/**
* cislovany seznam
* 1. prvni
* 2. druhy
*/
nelze použít vnořování seznamů
Šablony
pro opakující se texty (hlavně pro tagy), vychozí hodnoty v šabloně se mohou přepisovat