PHPDoc

Az oldal jelenlegi verzióját még nem ellenőrizték tapasztalt közreműködők, és jelentősen eltérhet a 2019. augusztus 28-án felülvizsgált verziótól ; az ellenőrzések 5 szerkesztést igényelnek .

A PHPDoc  egy adaptált Javadoc dokumentációs szabvány PHP -ben való használatra .

Leírás

Míg a kommentelő szabványnak csak formális státusza van, a tervek szerint a PHP-FIG csoport által kifejlesztett PHP keretrendszerek egyik fejlesztési szabványaként konszolidálják. A készülő szabvány a PSR-5 [1] számot kapja . A PHPDoc támogatja mind az objektumorientált , mind az eljárási kódot a dokumentumokban.

A kód értelmezésére külön phpDocumentor program készült .

A phpDocumentor egy olyan alkalmazás, amely képes a PHP forráskód és a DocBlock megjegyzések elemzésére az API dokumentáció teljes készletének létrehozásához [2] .

PHPDoc komponensek

Dokumentumblokkok

A Doc-blokkok ( eng.  DocBlock comments ) többsoros megjegyzések a C nyelv stílusában, amelyek a dokumentált elem előtt helyezkednek el. A megjegyzésben (és a megjegyzéssorok elején) az első karakternek * kell lennie . A blokkokat üres sorok választják el.

Egy példa Doc blokk a foo() függvényhez:

/** * @param string $msg string kimenetre * @author WikiEditor * @copyright 2016 Wikipédia * @return string változatlan */ function foo ( $msg = '' ) { return $msg ; }

PHPDoc szolgáltatások

  1. Támogatás a legújabb PHP verzióhoz
  2. Munka UML diagram osztályokkal
  3. Teljes szöveges keresés
  4. CI támogatás a dobozból
  5. Több vezérlés a DocBlocks segítségével

A PHPDoc verziói

A PHPDocumentator 3 aktuális verziója, Repository

Funkciók

  • Kompatibilis a PHP 7.0+ verziójával , teljes mértékben támogatja a névtereket, ciklusokat és egyebeket.
  • Docblock over type , docblocks explicitebb a típusokról, nem minden formátumot támogat a php.
  • Bármilyen címkét megjelenít, egyes címkék extra funkciókat adnak a phpDocumentorhoz (például @link).
  • Alacsony memóriahasználat , a kis projektek maximális memóriahasználata kevesebb, mint 20 MB, közepes projekteknél 40 MB, nagy keretrendszereknél pedig 100 MB.
  • Növekményes elemzés. Egy korábbi futtatásból származó szerkezetfájl mentésével a fent említett feldolgozási sebességnövekedés mellett további, akár 80%-os teljesítménynövekedés érhető el.
  • A sablon egyszerű létrehozása lehetővé teszi 1 feladat meghívását és 3 fájl szerkesztését.
  • Kétlépéses folyamat  : a phpDocumentor először létrehoz egy gyorsítótárat az alkalmazásstruktúrával, mielőtt a kimenetet generálja. Lehetővé teszi saját eszközeinek vagy formázóinak használatát.
  • Általános támogatás , a php statikusabb elemzésével a típusok bonyolultabbá váltak. A phpDocumentor megérti ezeket a típusokat. És első osztályú típusként jeleníti meg őket [2] .

Alkalmazás

Saját nagy projektek fejlesztésekor, amelyeknek minden finomságát nem lehet szem előtt tartani, csakúgy, mint mások projektjeinek véglegesítésekor, gyakran bele kell kukucskálni a korábban megírt kódba. Így pontosabban elképzelhető a visszaküldött, létrehozott objektumok és mit lehet velük kezdeni. Tekintettel arra, hogy a PHP implicit típusú öntéssel rendelkezik , hibák lehetségesek, amikor különböző típusú objektumokon hajtanak végre műveleteket. Erősen gépelt nyelveken ez nem fog megtörténni – a program egyszerűen nem fog lefordítani.

Ennek elkerülésére PHPDoc és más hasonló technológiákat használnak. Tegyük fel, hogy van egy kódunk :

... $eventData = new EventData (); $eventData -> feladó = $vezérlő ; $eventData -> name = 'onDelete' ; $eventData -> group = 'globális' ; $eventData -> argumentumok = tömb ( 'id' => 15 ); $eventDispatcher -> triggerEvent ( $eventData ); ...

A kódot olvasó külső fejlesztő nem biztos, hogy tudja, mit tartalmaz a $controller, de az IDE megmondja neki, hogy támogatja-e a PHPDoc-ot. Vagyis beírva: $controller->- láthatjuk, mi van belül. Ennek eredményeként nincs szükség a kód dzsungelébe való mélyedésbe, hogy megtudja, mit és milyen típusban halad át ez az objektum.

Linkek

Jegyzetek

  1. ↑ fig-standards/phpdoc.md phpDocumentor/fig-standards // GitHub . Hozzáférés dátuma: 2015. december 20. Az eredetiből archiválva : 2016. március 31.
  2. ↑ 1 2 Docker Hub . hub.docker.com _ Letöltve: 2022. szeptember 24.