Phpdoc és phpDocumentor
Hello, kedves blog olvasói LifeExample. Szeretnék megosztani veletek egy csodálatos módja annak, hogy dokumentálja a php script és webes projektek.
Generátor phpDocumentor PHP egy külön könyvtár egy sor álló körte.
Ha még soha nem telepített PEAR, azt tanácsolom, hogy olvassa el a cikk „Hogyan kell telepíteni a körte”
Hogyan kell használni phpdoc
Doc-script blokkot kell elosztani a következők szerint:
/ **
* Ez egy példa az osztály phpdoc doc-blokkok
* /
osztály SomeClass
# 123;
/ ** @type húr | null szöveget üdvözlő * /
védett $ weclome = null;
/ **
* Ez az eljárás beállítja a szöveg köszöntés.
*
* @param string $ text üdvözlő szöveg, maximum 255 karakter lehet.
*
* @return void
* /
public function setWeclomeText # 40; $ text # 41;
# 123;
$ Ez -> weclome = $ text;
# 125;
# 125;
Referencia paraméterei az alábbiakban ismertetünk.
Hogyan kell létrehozni dokumentáció keresztül phpDocumentor
Mint már mondtam phpDocumentor - ez PEAR könyvtár, amely lehetővé teszi, hogy hozzon létre dokumentációs fájlokat automatikusan. Ehhez szükség van az eszközöket, hogy működjön együtt a körte, és használja azt letölteni phpDocumentor.
A cikk „Hogyan kell telepíteni a körte” egy példa, phpDocumentor könyvtár telepítést. az eredmény, amely létrehoz egy könyvtárat C: \ Web szerverekhez \ usr \ local \ php5 \ data \ phpDocumentor. töltött generátor, a maguk teljességében, ami a web rendszer.
Az utasításoknak megfelelően, egy sor szoftver Denver, hozzon létre egy új mappát a C: \ Web szerverekhez \ home \ phpdocumentor.ru \ www és másolja a fájlokat a generátor dokumentálása
C: \ Web szerverekhez \ usr \ local \ php5 \ data \ phpDocumentor.
Figyelem! Ezeket az intézkedéseket úgy kell értelmezni, függetlenül az Ön WAMP (Windows, Apache, MySQL, PHP), ha Denver nem használják.
Ha felhívni a projekt phpdoc blokkok, fuss phpdocumentor.ru webes felület, és válassza ki a lap „output”.
Az első mezőben „Target”, adja meg az útvonalat, hogy a könyvtár, amelyben a dokumentációt hoz létre. Akkor megy a „Files” fülre.
A „Directory elemezni” adja meg az utat, hogy a gyökér a projekt.
Nyomja meg a „Create” a jobb alsó sarokban az oldal, és várjon, amíg a végén létrehozásának manuális folyamat.
Keresse meg azt a mappát, megadva a „kimeneti” fülre. látni fogja a sok fájlok és mappák, ezek mind dokumentáció egy adott projektet. Olvasd el a dokumentációt, akkor nyissa meg az index.html fájlt.
Amikor a beállításokat, kapok egy könyvtár a maga nemében.
Amellett, hogy a dokumentáció formájában egy sor html fájlokat, azt is lehetővé teszi, hogy hozzon létre phpDocumentor kézikönyvek PDF-be. CHM. XML formátumban.
Ahhoz, hogy maximalizálja a jól és világossá dokumentáció a projekt, meg kell tudni, phpdoc paraméter, melynek és mivel az összes dokumentációt jelölést.
Directory phpdoc
@api - jelzi a szerkezeti elem által használt harmadik féltől származó programok, és része az API-t.
Miután elolvasta az összes címkét a könyvtár phpDocumentor. Nem ajánlom, hogy bőséges a kínálat a phpdoc blokkokat. Véleményem szerint a legtöbb esetben elegendő csak néhány a rendelkezésre, mint például:
De ez nem jelenti azt, hogy a többi phpdoc paraméterek használhatatlanok. Minden helyzetben, meg kell külön-külön határozza meg annak leíró.
UTF-8 támogatás phpDocumentor
Minden jó, de ez a csoda generál dokumentáció nem támogatja az UTF-8, és ezért a cirill jelenik krakozyabrami.
PhpDocumentor barátkozni UTF-8, töltse le a következő fájlt
Most csomagolja ki a letöltött archív abba a könyvtárba, körtével: c: \ Web szerverekhez \ usr \ local \ php5 \ PEAR \. helyett az ott lévő phpDocumentor mappát.
Ha phpDocumentor emelkedik linux, majd csomagolja ki a letöltött archív abba a könyvtárba, körtével: / usr / share / php / phpDocumentor /. helyett az ott lévő phpDocumentor mappát.
Miután ezeket a lépéseket, akkor létrehoz dokumentációt, hogy támogassa a cirill ábécé és az UTF-8 kódolást.
Crack minta phpDocumentor
By the way, ha azt szeretnénk, hogy javítsa a sablont, vagy Russify, akkor meg tudja csinálni a könyvtárban: c: \ Web szerverekhez \ usr \ local \ php5 \ PEAR \ phpDocumentor \ phpDocumentor \ átalakítók \ html \ keretek \ templates \ DOM \ earthli \ templates \ (ez csak egy példa a könyvtárat a DOM :: earthli sablon)
Köszönöm a figyelmet, remélem az információ hasznos lesz az Ön számára!