| phpDocumentor | |
|---|---|
| Typ | Generátor dokumentace |
| Vývojář | Joshua Eichorn |
| Zapsáno v | PHP |
| Operační systém | multiplatformní |
| Nejnovější verze | 2.7.0 (20. 8. 2014 [1] ) |
| Licence | LGPL |
| webová stránka | phpdoc.org |
phpDocumentor je zdrojový dokumentační systém PHP . Má vestavěnou podporu pro generování dokumentace ve formátech HTML , LaTeX , man , RTF a XML . Výstup lze také snadno převést do CHM , PostScript , PDF . Alternativou k použití phpDocumentoru je Doxygen [ 2] .
Lze jej používat jak z příkazové řádky , tak pomocí webového rozhraní [3] . Rozumí syntaxi 4. a 5. verze jazyka PHP . Distribuováno pod licencí LGPL .
Systém je založen na parsování logické struktury PHP kódu (třídy, funkce, proměnné, konstanty) a připojování k němu komentářů napsaných podle určitých standardů.
Komentáře pro phpDocumentor se nazývají Doc-bloky ( komentáře DocBlock ). Jsou formátovány jako víceřádkové komentáře ve stylu C . V každém případě musí komentář předcházet dokumentovanému prvku. První znak v komentáři (a na začátku řádků komentáře) musí být * . Bloky jsou odděleny prázdnými řádky.
/** * Název objektu nebo krátký popis * * Dlouhý popis * * Hodnota @descriptor_name * @return data_type */Všechny ostatní komentáře jsou systémem ignorovány.
Popisy umožňují použití některých značek HTML:
Slova začínající symbolem "@" se používají k zápisu příkazů analyzátoru a nazývají se deskriptory ( tagy, štítky ). Standardní deskriptory jsou na začátku řádku. Deskriptory uvnitř řetězce jsou uzavřeny ve složených závorkách {} a nazývají se inline ( anglicky inline tag ) deskriptory.
/** * Chyba! @error standardní značka v řádku * Toto je vložená značka {@inlinetag} * @standardtag je standardní značka */
| Seznam úchytů phpDocumentor | ||
|---|---|---|
| Deskriptor | Popis | Příklad |
| @author | Autor | /** * Ukázkový soubor 2, rychlý start phpDocumentor * * Soubor z dokumentace phpDocumentor *, který ukazuje, jak komentovat. * @author Greg Beaver <celllog@php.net> * @verze 1.0 * @ukázka balíčku * @třídy podbalíčků */ |
| @version | Verze kódu | |
| @package | Určuje balíček, ke kterému kód patří | |
| @subpackage | Určuje dílčí balíček | |
| @global | Popis globálních proměnných | /** * DocBlock pro globální proměnnou * @global integer $GLOBALS['myvar'] následovaný funkcí s globální proměnnou * nebo globální proměnnou, v takovém případě musíte zadat její název * @name $myvar */ $ GLOBÁLNÍ [ 'myvar' ] = 6 ; |
| @name | Jméno, štítek | |
| @staticvar | Popis statických proměnných | /** * @staticvar integer $staticvar * @return vrací celočíselnou hodnotu */ |
| @return | Popis návratové hodnoty | |
| @todo | Poznámky pro pozdější implementaci. | /** * DocBlock s vnořenými seznamy * @todo Jednoduchý seznam TODO * - položka 1 * - položka 2 * - položka 3 * @todo Vnořený seznam TODO * <ol> * <li>položka 1.0</li> * <li> položka 2.0</li> * <ol> * <li>položka 2.1</li> * <li>položka 2.2</li> * </ol> * <li>položka 3.0</li> * </ol> */ |
| @link | Odkaz | /** * Toto je příklad {@link http://www.example.com vloženého hypertextového odkazu} */ |
| @deprecated (@deprec) | Popis zastaralého bloku | /** * @deprecated description * @deprec je synonymum pro deprecated */ |
| @example | Příklad | /** * @abstrakt * @přístup veřejný nebo soukromý * @datum názvu autorských práv * @příklad /cesta/k/příkladu * @ignore * @interní soukromé informace pro specialisty * @typ parametru [$varname] popis vstupního parametru * @return typ návratové hodnoty popis * @viz další název prvku (odkaz) * @od verze nebo data * @statický */ |
| @see | Odkaz na jiné místo v dokumentaci | |
| Další deskriptory | ||
| @copyright • @license • @filesource • @category • @since • @abstract • @access • @example • @ignore • @internal • @static • @throws • @uses • @tutorial | ||