PHPDoc

Versiunea actuală a paginii nu a fost încă examinată de colaboratori experimentați și poate diferi semnificativ de versiunea revizuită pe 28 august 2019; verificările necesită 5 modificări .

PHPDoc este un standard de documentație Javadoc  adaptat pentru utilizare în PHP .

Descriere

În timp ce standardul de comentarii are doar un statut formal, este planificat să îl consolideze ca unul dintre standardele de dezvoltare pentru cadrele PHP dezvoltate de grupul PHP-FIG. Standardul în curs de pregătire va primi numărul PSR-5 [1] . PHPDoc acceptă atât codul orientat pe obiecte, cât și codul procedural în documente.

Un program phpDocumentor separat a fost creat pentru a interpreta codul .

phpDocumentor este o aplicație capabilă să analizeze codul sursă PHP și comentariile DocBlock pentru a genera un set complet de documentație API [2] .

Componente PHPDoc

Blocuri de documente

Doc-blocks ( ing.  DocBlock comments ) sunt comentarii cu mai multe linii în stilul limbajului C , situate înaintea elementului documentat. Primul caracter dintr-un comentariu (și la începutul liniilor de comentariu) trebuie să fie * . Blocurile sunt separate prin linii goale.

Un exemplu de bloc Doc pentru funcția foo():

/** * @param șir $msg șir de ieșire * @author WikiEditor * @copyright 2016 Wikipedia * @return șir neschimbat */ function foo ( $msg = '' ) { return $msg ; }

Caracteristici PHPDoc

  1. Suport pentru cea mai recentă versiune PHP
  2. Lucrul cu clase de diagrame UML
  3. Căutare text integral
  4. Suport CI din cutie
  5. Mai mult control cu ​​DocBlocks

Versiuni de PHPDoc

Versiunea actuală a PHPDocumentator 3, Repository

Funcții

  • Compatibil cu PHP 7.0+ , suport complet pentru spații de nume, bucle și multe altele.
  • Docblock peste tipuri , docblocks este mai explicit despre tipuri, nu toate formatele sunt acceptate de php.
  • Redă orice etichetă , unele etichete adaugă funcționalitate suplimentară la phpDocumentor (cum ar fi @link).
  • Utilizarea redusă a memoriei , utilizarea maximă a memoriei pentru proiectele mici este mai mică de 20 MB, pentru proiectele medii este de 40 MB, iar pentru cadrele mari este de 100 MB.
  • Analiza incrementală. Prin salvarea unui fișier de structură dintr-o rulare anterioară, există o creștere suplimentară a performanței de până la 80% în plus față de creșterea vitezei de procesare menționată mai sus.
  • Crearea simplă a unui șablon face posibilă apelarea unei sarcini și editarea a 3 fișiere.
  • Proces în doi pași  : phpDocumentor creează mai întâi un cache cu structura aplicației înainte de a genera rezultate. Vă permite să utilizați propriile instrumente sau formatoare.
  • Suport general , cu o analiză mai statică în php, tipurile au devenit mai complexe. phpDocumentor înțelege aceste tipuri. Și le va afișa ca tipuri de primă clasă [2] .

Aplicație

Când vă dezvoltați propriile proiecte mari, ale căror subtilități nu pot fi reținute, la fel ca atunci când finalizați proiectele altora, trebuie adesea să vă uitați în codul scris anterior. Acest lucru vă permite să vă imaginați mai precis obiectele returnate, create și ce puteți face cu ele. Având în vedere că PHP are tip casting implicit , erorile sunt potențial posibile atunci când operațiunile sunt efectuate pe obiecte de diferite tipuri. În limbile puternic tastate , acest lucru nu se va întâmpla - programul pur și simplu nu se va compila.

Pentru a evita acest lucru, se folosesc PHPDoc și alte tehnologii similare. Să presupunem că avem un cod :

... $eventData = new EventData (); $eventData -> expeditor = $controller ; $eventData -> nume = 'onDelete' ; $eventData -> grup = 'global' ; $eventData -> arguments = array ( 'id' => 15 ); $eventDispatcher -> triggerEvent ( $eventData ); ...

Un dezvoltator terță parte care citește acest cod poate să nu știe ce conține $controller, dar IDE-ul îi va spune dacă acceptă PHPDoc. Adică tastând: $controller->- putem vedea ce este înăuntru. Drept urmare, nu este nevoie să vă adânciți în jungla codului pentru a afla ce este trecut de acest obiect și în ce tip.

Link -uri

Note

  1. ↑ fig-standards/phpdoc.md phpDocumentor/fig-standards // GitHub . Data accesului: 20 decembrie 2015. Arhivat din original la 31 martie 2016.
  2. ↑ 1 2 Docker Hub . hub.docker.com _ Preluat: 24 septembrie 2022.