| phpDocumentor | |
|---|---|
| Type | Dokumentationsgenerator |
| Udvikler | Joshua Eichorn |
| Skrevet i | PHP |
| Operativ system | på tværs af platforme |
| nyeste version | 2.7.0 (20/08/2014 [1] ) |
| Licens | LGPL |
| Internet side | phpdoc.org |
phpDocumentor er et PHP -kildedokumentationssystem . Den har indbygget understøttelse til generering af dokumentation i HTML- , LaTeX- , man- , RTF- og XML-formater . Outputtet kan også nemt konverteres til CHM , PostScript , PDF . Et alternativ til at bruge phpDocumentor er Doxygen [2] .
Det kan bruges både fra kommandolinjen og ved hjælp af webgrænsefladen [3] . Forstår syntaksen for den 4. og 5. version af PHP -sproget . Distribueret under LGPL -licensen .
Systemet er baseret på at analysere den logiske struktur af PHP-kode (klasser, funktioner, variabler, konstanter) og vedhæfte kommentarer skrevet i henhold til visse standarder til det.
Kommentarer til phpDocumentor kaldes Doc-blocks ( DocBlock comments ). De er formateret som kommentarer med flere linjer i C -stilen . Kommentaren skal i hvert tilfælde komme før det dokumenterede element. Det første tegn i en kommentar (og i begyndelsen af kommentarlinjerne) skal være * . Blokke er adskilt af tomme linjer.
/** * Objektnavn eller kort beskrivelse * * Lang beskrivelse * * @descriptor_name value * @return data_type */Alle andre kommentarer ignoreres af systemet.
Beskrivelser tillader brug af nogle HTML-tags:
Ord, der begynder med symbolet "@" bruges til at skrive parser-kommandoer og kaldes deskriptorer ( mærker, etiketter ). Standardbeskrivelser er i begyndelsen af linjen. Deskriptorer inde i en streng er omgivet af krøllede klammeparenteser {} og kaldes inline ( eng. inline tag ) deskriptorer.
/** * Fejl! @error standard tag in line * Dette er et inline {@inlinetag} tag * @standardtag er et standard tag */
| Liste over phpDocumentor- håndtag | ||
|---|---|---|
| Deskriptor | Beskrivelse | Eksempel |
| @author | Forfatter | /** * Eksempelfil 2, phpDocumentor Quickstart * * En fil fra phpDocumentor-dokumentationen *, der viser, hvordan man kommenterer. * @forfatter Greg Beaver <[email protected]> * @version 1.0 * @pakkeeksempel * @underpakkeklasser */ |
| @version | Kode version | |
| @package | Angiver den pakke, som koden tilhører | |
| @subpackage | Angiver en underpakke | |
| @global | Beskrivelse af globale variabler | /** * DocBlock for en global variabel * @global heltal $GLOBALS['myvar'] efterfulgt af en funktion med en global variabel * eller en global variabel, i hvilket tilfælde du skal angive dens navn * @name $myvar */ $ GLOBALS [ 'myvar' ] = 6 ; |
| @name | Navn, etiket | |
| @staticvar | Beskrivelse af statiske variable | /** * @staticvar heltal $staticvar * @return returnerer en heltalsværdi */ |
| @return | Beskrivelse af returværdi | |
| @todo | Noter til senere implementering. | /** * DocBlock med indlejrede lister * @todo Simple TODO-liste * - item 1 * - item 2 * - item 3 * @todo Nested TODO-liste * <ol> * <li>item 1.0</li> * <li> item 2.0</li> * <ol> * <li>emne 2.1</li> * <li>emne 2.2</li> * </ol> * <li>emne 3.0</li> * </ol> */ |
| @link | Link | /** * Dette er et eksempel på {@link http://www.example.com indlejret hyperlink} */ |
| @deprecated (@deprec) | Beskrivelse af den forældede blok | /** * @deprecated description * @deprec er et synonym for forældet */ |
| @example | Eksempel | /** * @abstract * @adgang offentlig eller privat * @copyright navn dato * @eksempel /sti/til/eksempel * @ignorer * @intern privat information for specialister * @param type [$varname] input parameterbeskrivelse * @return skriv returværdibeskrivelse * @se andet elementnavn (reference) * @siden version eller dato * @statisk */ |
| @see | Link til et andet sted i dokumentationen | |
| Andre beskrivelser | ||
| @copyright • @license • @filesource • @category • @since • @abstract • @access • @example • @ignore • @internal • @static • @throws • @uses • @tutorial | ||