| phpDocumentor | |
|---|---|
| Sorts | Dokumentationsgenerator |
| Utvecklaren | Joshua Eichorn |
| Skrivet i | PHP |
| Operativ system | plattformsoberoende |
| senaste versionen | 2.7.0 (2014-08-20 [1] ) |
| Licens | LGPL |
| Hemsida | phpdoc.org |
phpDocumentor är ett PHP -källdokumentationssystem . Den har inbyggt stöd för att generera dokumentation i HTML- , LaTeX- , man- , RTF- och XML-format . Utdata kan också enkelt konverteras till CHM , PostScript , PDF . Ett alternativ till att använda phpDocumentor är Doxygen [2] .
Den kan användas både från kommandoraden och med webbgränssnittet [3] . Förstår syntaxen för den fjärde och femte versionen av PHP- språket . Distribueras under LGPL -licensen .
Systemet är baserat på att analysera PHP-kodens logiska struktur (klasser, funktioner, variabler, konstanter) och bifoga kommentarer skrivna enligt vissa standarder till den.
Kommentarer för phpDocumentor kallas Doc-blocks ( DocBlock comments ). De är formaterade som kommentarer med flera rader i C -stilen . I varje fall måste kommentaren komma före det dokumenterade elementet. Det första tecknet i en kommentar (och i början av kommentarsraderna) måste vara * . Blocken separeras med tomma rader.
/** * Objektnamn eller kort beskrivning * * Lång beskrivning * * @descriptor_name value * @return data_type */Alla andra kommentarer ignoreras av systemet.
Beskrivningar tillåter användning av vissa HTML-taggar:
Ord som börjar med symbolen "@" används för att skriva parserkommandon och kallas deskriptorer ( taggar, etiketter ). Standardbeskrivningar finns i början av raden. Deskriptorer inuti en sträng är inneslutna i hängslen {} och kallas inline ( eng. inline tag ) deskriptorer.
/** * Fel! @error standardtagg i rad * Detta är en inline {@inlinetag}-tagg * @standardtagg är en standardtagg */
| Lista över phpDocumentor- handtag | ||
|---|---|---|
| Beskrivare | Beskrivning | Exempel |
| @author | Författare | /** * Exempelfil 2, phpDocumentor Snabbstart * * En fil från phpDocumentor-dokumentationen * som visar hur man kommenterar. * @författare Greg Beaver <cellog@php.net> * @version 1.0 * @package sample * @subpackage classes */ |
| @version | Kodversion | |
| @package | Anger paketet som koden tillhör | |
| @subpackage | Anger ett underpaket | |
| @global | Beskrivning av globala variabler | /** * DocBlock för en global variabel * @globalt heltal $GLOBALS['myvar'] följt av en funktion med en global variabel * eller en global variabel, i vilket fall du måste ange dess namn * @name $myvar */ $ GLOBALS [ 'myvar' ] = 6 ; |
| @name | Namn, etikett | |
| @staticvar | Beskrivning av statiska variabler | /** * @staticvar heltal $staticvar * @return returnerar ett heltalsvärde */ |
| @return | Beskrivning av returvärde | |
| @todo | Anmärkningar för senare implementering. | /** * DocBlock med kapslade listor * @todo Enkel TODO-lista * - item 1 * - item 2 * - item 3 * @todo Nested TODO-lista * <ol> * <li>item 1.0</li> * <li> objekt 2.0</li> * <ol> * <li>objekt 2.1</li> * <li>objekt 2.2</li> * </ol> * <li>objekt 3.0</li> * </ol> */ |
| @link | Länk | /** * Det här är ett exempel på {@link http://www.example.com inbäddad hyperlänk} */ |
| @deprecated (@deprec) | Beskrivning av det föråldrade blocket | /** * @deprecated description * @deprec är en synonym för utfasad */ |
| @example | Exempel | /** * @abstract * @åtkomst offentlig eller privat * @copyright namndatum * @exempel /sökväg/till/exempel * @ignorera * @intern privat information för specialister * @paramtyp [$varname] indataparameterbeskrivning * @return typ returvärdebeskrivning * @se annat elementnamn (referens) * @sedan version eller datum * @statisk */ |
| @see | Länk till annan plats i dokumentationen | |
| Andra beskrivningar | ||
| @copyright • @license • @filesource • @category • @since • @abstract • @access • @example • @ignore • @internal • @static • @throws • @uses • @tutorial | ||