Phpdoc și phpdocumentor

Bună ziua, dragi cititori blog LifeExample. Vreau să împărtășesc cu voi un mod minunat de a documenta scripturi PHP și proiecte web.

Generator phpDocumentor PHP este o bibliotecă separată într-un set de PEAR disponibile.

Dacă nu ați instalat PEAR, te sfătuiesc să citiți articolul „Cum se instalează Pear“

Cum să utilizați phpdoc

blocuri Doc-script care urmează să fie alocate după cum urmează:

/ **
* Acesta este un exemplu de clasă phpdoc doc-blocuri
* /
clasa SomeClass
# 123;
/ ** string @type | null salut Text * /
protejat $ Weclome = null;

/ **
* Această metodă stabilește urarea de text.
*
* @param string $ text de felicitare text, maximum 255 de caractere.
*
* Void @return
* /
funcția publică setWeclomeText # 40; $ Text # 41;
# 123;
$ Acest - text> Weclome = $;
# 125;
# 125;

Parametrii bloc de referință vor fi prezentate mai jos.

Cum de a genera documente prin phpDocumentor

Așa cum am spus phpDocumentor - biblioteca aceasta PEAR care vă permite să creați fișiere de documentare în mod automat. Pentru a face acest lucru, trebuie să aveți instrumentele necesare pentru a lucra cu PEAR, și folosindu-l pentru a descărca phpDocumentor.

În articolul „Cum se instalează Pear“ este un exemplu, instalarea de bibliotecă phpDocumentor. rezultatul, care ar trebui să creeze un director C: \ webservere \ usr \ local de \ PHP5 \ date \ PhpDocumentor. umplut generatorul de fișiere, în totalitatea lor, ceea ce reprezintă sistemul de web.

În conformitate cu instrucțiunile, folosind un set de software Denver, a crea un nou dosar C: \ webservere \ acasă \ phpdocumentor.ru \ www și copia fișierele documentația generatorului de
C: \ webservere \ usr \ local de \ PHP5 \ date \ PhpDocumentor.

Atenție! Aceste acțiuni ar trebui să fie interpretate în mod independent, în conformitate cu WAMP (Windows, Apache, MySQL, PHP), în cazul în care Denver nu este utilizat.

Când desenați blocuri phpdoc proiect, rulați interfața web phpdocumentor.ru și selectați fila „OUTPUT“.

În primul câmp „Target“, specificați calea către directorul în care va fi creat documentația. Apoi, du-te la tab-ul „Files“.

În „Directory pentru a analiza“ a specifica calea către rădăcina proiectului.

Apăsați butonul „Create“ în colțul din dreapta jos al paginii, și așteptați până la sfârșitul anului de a crea proces manual.
Navigați la folderul specificat în fila „OUTPUT“. veți vedea mai multe fișiere și foldere, acestea sunt toate documentele pentru un anumit proiect. Citiți documentația, puteți deschide fișierul index.html.

Când setările mele, am obține un director de acest gen.

În plus față de documentația sub forma unui set de fișiere HTML, de asemenea, vă permite să creați manuale phpDocumentor în PDF. CHM. formate XML.

Pentru a maximiza fântânii și să facă o documentație clară a proiectului, trebuie să știți parametrii phpdoc prin care și este dat tot marcajul de documentare.

Director phpdoc

@api - marchează un element structural utilizat de programe terțe, și face parte din API.

Dupa ce a citit toate etichetele din directorul de phpDocumentor. Nu vă recomandăm să alimentare din abundenta de blocuri phpdoc. În opinia noastră, suficientă în cele mai multe cazuri, doar câteva dintre disponibile, cum ar fi:

Dar acest lucru nu înseamnă că parametrii de odihnă phpdoc sunt inutile. Pentru fiecare situație, trebuie să specificați în mod individual un anumit descriptor.

suport UTF-8 în phpDocumentor

Toate mare, dar această minune a genera documentație nu acceptă UTF-8 și, prin urmare, apare chirilic krakozyabrami.

PhpDocumentor pentru a face prieteni cu UTF-8, descărcați următorul fișier

Acum despachetați arhiva descărcat în directorul cu PEAR: c: \ webservere \ usr \ locale \ PHP5 \ PEAR \. înlocuind existent în acesta dosarul PhpDocumentor.

Dacă phpDocumentor se ridică pe Linux, apoi despachetați arhiva descărcat în directorul cu PEAR: / usr / share / php / PhpDocumentor /. înlocuind existent în acesta dosarul PhpDocumentor.

După acești pași, puteți genera documentație pentru a sprijini alfabetul chirilic și codificarea UTF-8.

Crack model phpDocumentor

Apropo, dacă doriți să îmbunătățească aspectul șablonului, sau russify-l, puteți face acest lucru în directorul: c: \ webservere \ usr \ locale \ PHP5 \ PEAR \ PhpDocumentor \ phpDocumentor \ Convertoare \ HTML \ cadre \ template-uri \ DOM \ earthli \ template \ (acesta este un exemplu de director la DOM :: template earthli)

Vă mulțumesc pentru atenție, sper că informațiile vor fi utile pentru tine!