| phpDocumentor | |
|---|---|
| Tip de | Generator de documentație |
| Dezvoltator | Joshua Eichorn |
| Scris in | PHP |
| Sistem de operare | multiplatformă |
| ultima versiune | 2.7.0 (20.08.2014 [1] ) |
| Licență | LGPL |
| Site-ul web | phpdoc.org |
phpDocumentor este un sistem de documentare sursă PHP . Are suport încorporat pentru generarea de documentație în formate HTML , LaTeX , man , RTF și XML . De asemenea, rezultatul poate fi convertit cu ușurință în CHM , PostScript , PDF . O alternativă la utilizarea phpDocumentor este Doxygen [2] .
Poate fi folosit atât din linia de comandă, cât și folosind interfața Web [3] . Înțelege sintaxa versiunilor a 4-a și a 5-a a limbajului PHP . Distribuit sub licență LGPL .
Sistemul se bazează pe analizarea structurii logice a codului PHP (clase, funcții, variabile, constante) și atașarea de comentarii scrise conform anumitor standarde.
Comentariile pentru phpDocumentor se numesc Doc-blocks ( comentarii DocBlock ). Sunt formatate ca comentarii pe mai multe rânduri în stilul C. În fiecare caz, comentariul trebuie să apară înaintea elementului documentat. Primul caracter dintr-un comentariu (și la începutul liniilor de comentariu) trebuie să fie * . Blocurile sunt separate prin linii goale.
/** * Nume obiect sau descriere scurtă * * Descriere lungă * * @descriptor_name valoare * @return data_type */Toate celelalte comentarii sunt ignorate de sistem.
Descrierile permit utilizarea unor etichete HTML:
Cuvintele care încep cu simbolul „@” sunt folosite pentru a scrie comenzile parserului și sunt numite descriptori ( etichete, etichete ). Descriptorii standard sunt la începutul rândului. Descriptorii din interiorul unui șir sunt încadrați în acolade {} și sunt numiți descriptori inline ( eng. inline tag ).
/** * Eroare! @error etichetă standard în linie * Aceasta este o etichetă inline {@inlinetag} * @standardtag este o etichetă standard */
| Lista de mânere phpDocumentor | ||
|---|---|---|
| Descriptor | Descriere | Exemplu |
| @author | Autor | /** * Exemplu de fișier 2, phpDocumentor Quickstart * * Un fișier din documentația phpDocumentor * care demonstrează cum să comentezi. * @author Greg Beaver <cellog@php.net> * @version 1.0 * @package sample * @subpackage classs */ |
| @version | Versiunea codului | |
| @package | Specifică pachetul căruia îi aparține codul | |
| @subpackage | Specifică un subpachet | |
| @global | Descrierea variabilelor globale | /** * DocBlock pentru o variabilă globală * @global integer $GLOBALS['myvar'] urmat de o funcție cu o variabilă globală * sau o variabilă globală, caz în care trebuie să specificați numele acesteia * @name $myvar */ $ GLOBALE [ ' myvar ' ] = 6 ; |
| @name | Nume, etichetă | |
| @staticvar | Descrierea variabilelor statice | /** * @staticvar întreg $staticvar * @return returnează o valoare întreagă */ |
| @return | Descrierea valorii returnate | |
| @todo | Note pentru implementare ulterioară. | /** * DocBlock cu liste imbricate * @todo Lista simplă de TODO * - elementul 1 * - elementul 2 * - elementul 3 * @todo Listă imbricată de TODO * <ol> * <li>elementul 1.0</li> * <li> elementul 2.0</li> * <ol> * <li>articolul 2.1</li> * <li>articolul 2.2</li> * </ol> * <li>articolul 3.0</li> * </ol> */ |
| @link | Legătură | /** * Acesta este un exemplu de {@link http://www.example.com hyperlink încorporat} */ |
| @deprecated (@deprec) | Descrierea blocului învechit | /** * @deprecated description * @deprec este un sinonim pentru deprecated */ |
| @example | Exemplu | /** * @abstract * @access public sau privat * @copyright nume data * @example /path/to/example * @ignore * @informații private interne pentru specialiști * @param type [$varname] descriere parametru de intrare * @return tip returnare valoare descriere * @vedeți alt nume de element (referință) * @din versiune sau dată * @static */ |
| @see | Link către un alt loc din documentație | |
| Alți descriptori | ||
| @copyright • @license • @filesource • @category • @since • @abstract • @access • @example • @ignore • @internal • @static • @throws • @uses • @tutorial | ||