| phpDocumentor | |
|---|---|
| Tyyppi | Dokumentaatiogeneraattori |
| Kehittäjä | Joshua Eichorn |
| Sisään kirjoitettu | PHP |
| Käyttöjärjestelmä | cross-platform |
| uusin versio | 2.7.0 (20.8.2014 [1] ) |
| Lisenssi | LGPL |
| Verkkosivusto | phpdoc.org |
phpDocumentor on PHP -lähdedokumentaatiojärjestelmä . Siinä on sisäänrakennettu tuki dokumentaation luomiseen HTML- , LaTeX- , man- , RTF- ja XML-muodoissa . Myös tuloste voidaan helposti muuntaa CHM , PostScript , PDF : ksi . Vaihtoehto phpDocumentorin käytölle on Doxygen [2] .
Sitä voidaan käyttää sekä komentoriviltä että web-käyttöliittymän avulla [3] . Ymmärtää PHP - kielen neljännen ja viidennen version syntaksin . Jaettu LGPL -lisenssillä .
Järjestelmä perustuu PHP-koodin loogisen rakenteen (luokat, funktiot, muuttujat, vakiot) jäsentämiseen ja tiettyjen standardien mukaan kirjoitettujen kommenttien liittämiseen siihen.
phpDocumentorin kommentteja kutsutaan Doc-lohkoiksi ( DocBlock - kommentit ). Ne on muotoiltu monirivisiksi kommenteiksi C -tyyliin . Kussakin tapauksessa kommentin on tultava ennen dokumentoitua elementtiä. Kommentin ensimmäisen merkin (ja kommenttirivien alussa) on oltava * . Lohkot erotetaan tyhjillä viivoilla.
/** * Objektin nimi tai lyhyt kuvaus * * Pitkä kuvaus * * @descriptor_name value * @return data_type */Järjestelmä jättää huomioimatta kaikki muut kommentit.
Kuvaukset sallivat joidenkin HTML-tunnisteiden käytön:
"@"-symbolilla alkavia sanoja käytetään jäsennyskomentojen kirjoittamiseen, ja niitä kutsutaan kuvailijoiksi ( tunnisteet, pikakuvakkeet ). Vakiokuvaajat ovat rivin alussa. Merkkijonon sisällä olevat kuvaukset on suljettu aaltosulkeisiin {}, ja niitä kutsutaan inline ( eng. inline tag ) kuvailijoiksi.
/** * Virhe! @error standarditunniste rivillä * Tämä on rivin sisäinen {@inlinetag} -tunniste * @standardtag on vakiotunniste */
| Luettelo phpDocumentor- kahvoista | ||
|---|---|---|
| Kuvaaja | Kuvaus | Esimerkki |
| @author | Tekijä | /** * Esimerkkitiedosto 2, phpDocumentor Quickstart * * Tiedosto phpDocumentor dokumentaatiosta *, joka näyttää kuinka kommentoida. * @author Greg Beaver <[email protected]> * @versio 1.0 * @package sample * @subpackage classes */ |
| @version | Koodi versio | |
| @package | Määrittää paketin, johon koodi kuuluu | |
| @subpackage | Määrittää alipaketin | |
| @global | Globaalien muuttujien kuvaus | /** * DocBlock globaalille muuttujalle * @global integer $GLOBALS['myvar'] ja sen jälkeen funktio globaalilla muuttujalla * tai globaalilla muuttujalla, jolloin sinun on määritettävä sen nimi * @nimi $myvar */ $ GLOBAALIT [ 'myvar' ] = 6 ; |
| @name | Nimi, etiketti | |
| @staticvar | Staattisten muuttujien kuvaus | /** * @staticvar kokonaisluku $staticvar * @return palauttaa kokonaisluvun */ |
| @return | Palautusarvon kuvaus | |
| @todo | Huomautuksia myöhempää käyttöönottoa varten. | /** * DocBlock sisäkkäisillä luetteloilla * @todo Yksinkertainen TODO-lista * - kohde 1 * - kohde 2 * - kohde 3 * @todo Sisäkkäinen TODO-luettelo * <ol> * <li>kohde 1.0</li> * <li> kohde 2.0</li> * <ol> * <li>tuote 2.1</li> * <li>kohde 2.2</li> * </ol> * <li>kohde 3.0</li> * </ol> */ |
| @link | Linkki | /** * Tämä on esimerkki {@link http://www.example.com upotetusta hyperlinkistä} */ |
| @deprecated (@deprec) | Kuvaus vanhentuneesta lohkosta | /** * @deprecated description * @deprec on synonyymi sanalle vanhentunut */ |
| @example | Esimerkki | /** * @abstract * @pääsy julkinen tai yksityinen * @copyright nimi päivämäärä * @esimerkki /polku/esimerkki * @ohita * @sisäiset yksityiset tiedot asiantuntijoille * @param type [$varname] syöttöparametrin kuvaus * @return tyyppi palautusarvon kuvaus * @katso muun elementin nimi (viite) * @versiosta tai päivämäärästä * @static */ |
| @see | Linkki toiseen paikkaan dokumentaatiossa | |
| Muut kuvailevat | ||
| @copyright • @license • @filesource • @category • @since • @abstract • @access • @example • @ignore • @internal • @static • @throws • @uses • @tutorial | ||