Phpdoc и phpdocumentor

Здравейте, скъпи читатели на блога LifeExample. Искам да споделя с вас един чудесен начин да се документира вашите PHP скриптове и уеб проекти.

Generator phpDocumentor PHP е отделна библиотека в набор от налични PEAR.

Ако никога не сте инсталирали круша, Съветвам ви да прочетете статията "Как да инсталирате круша"

Как да използвате PHPdoc

Док азбука блокове, за да се разпределят, както следва:

/ **
* Това е пример на клас phpDoc док блокове
* /
клас SomeClass
# 123;
/ ** @type низ | нула поздравителен текст * /
защитен $ Weclome = нула;

/ **
* Този метод определя поздравителен текст.
*
* @param низ $ поздравителен текст текст, максималните 255 знака.
*
* @return нищожно
* /
обществена функция setWeclomeText # 40; $ текст # 41;
# 123;
$ Това -> Weclome = $ текст;
# 125;
# 125;

Референтен блокови параметри ще бъдат дадени по-долу.

Как да се генерира чрез документация phpDocumentor

Както вече казах phpDocumentor - това PEAR библиотека, която ви позволява да създавате файлове с документация автоматично. За да направите това, трябва да има инструменти за работа с круша, и да го използвате, за да изтеглите phpDocumentor.

В статията "Как да инсталирате круша" е пример, монтаж phpDocumentor библиотека. резултата, който трябва да се създаде директория C: \ уеб сървъри \ ЮЕсАр \ Local \ php5 \ Data \ PhpDocumentor. попълнено генератор на файла, в своята съвкупност, представляваща уеб система.

В съответствие с инструкциите, като се използва набор от софтуер Денвър, да създадете нова папка C: \ уеб сървъри \ у дома \ phpdocumentor.ru \ WWW и да копирате файловете на документацията за генератор на
C: \ уеб сървъри \ ЮЕсАр \ Local \ php5 \ Data \ PhpDocumentor.

Внимание! Тези действия следва да се тълкува независимо под ваш WAMP (Windows, Apache, MySQL, PHP), ако Денвър не се използва.

Когато се направи вашите phpDoc блокове проекта, стартирайте phpdocumentor.ru уеб интерфейс и изберете раздела "изход".

В първото поле "Target", укажете пътя до директорията, в която ще бъде създадена документацията. След това отидете на "Files" раздел.

В "директория да се направи разбор" укажете пътя до корена на вашия проект.

Натиснете бутона "Create" в долния десен ъгъл на страницата, и да изчака края на създаване на ръчен процес.
Намерете папката, посочена в "изход" в раздела. ще видите много файлове и папки, те са цялата документация за даден проект. Прочетете документацията, можете да отворите файла index.html.

Когато настройките ми, получавам директория от този вид.

В допълнение към документацията във вид на набор от HTML файлове, също така ви позволява да създадете ръководства phpDocumentor да PDF формат. CHM. XML формати.

За увеличаване на кладенеца и да направи ясна документация на проекта, което трябва да знаете phpDoc параметри, с което и се предоставя цялата маркиране на документация.

Directory phpDoc

@api - бележи структурен елемент, използван от програмите за трети страни, и е част от API.

След прочитане на всички маркери от указателя на phpDocumentor. Не ви препоръчваме да се голямо предлагане на phpDoc блокове. По мое мнение, е достатъчно в повечето случаи само няколко от наличните, като например:

Но това не означава, че параметрите на phpDoc почивка са безполезни. За всяка ситуация, трябва да се посочи конкретен индивидуално ЕВРОВОК.

UTF-8 поддръжка в phpDocumentor

Всичко чудесно, но това чудо генерира документация не поддържа UTF-8 и следователно кирилица появява krakozyabrami.

PhpDocumentor да се сприятеля с UTF-8, изтеглете следния файл

Сега разопаковането сваления архив в указателя с PEAR: C: \ уеб сървъри \ ЮЕсАр \ Local \ php5 \ PEAR \. заместване на съществуващата там папка PhpDocumentor.

Ако phpDocumentor издига на Linux, а след разопаковането сваления архив в указателя с PEAR: / ЮЕсАр / акции / PHP / PhpDocumentor /. заместване на съществуващата там папка PhpDocumentor.

След тези стъпки, можете да генерирате документация в подкрепа на кирилицата и UTF-8 кодиране.

Crack модел phpDocumentor

Между другото, ако искате да се подобри оформление шаблон, или russify него, можете да го направите в директорията: C: \ уеб сървъри \ ЮЕсАр \ Local \ php5 \ PEAR \ PhpDocumentor \ phpDocumentor \ преобразуватели \ HTML \ рамки \ шаблони \ DOM \ earthli \ шаблони \ (това е пример за директорията на DOM :: earthli шаблон)

Благодаря ви за вниманието, надявам се тази информация ще бъде полезна за вас!