Инсталиране на PhpDocumentor в Windows и създаване на документация

PHPDocumentor е инструмент, който ви позволява да генерирате документация директно от изходния код на PHP.

Инструкции за инсталиране на PhpDocumentor по няколко начина и по-нататъшното му използване

Внимание! За да избегнете грешки при инсталиране и използване на PhpDocumentor, е желателно да добавите PHP към "Променливите на средата" на Windows. Можете да прочетете как да направите това тук: Windows и Denwer. Добавяне на PHP към променливите на средата.

Инсталиране на PhpDocumentor с PEAR

Предупреждение! За да инсталирате phpDocumentor ще ви трябва PEAR. Ако не сте го инсталирали, инсталирайте го, като използвате статията: Инсталиране на PEAR на Windows (denwer, php 5.3).

Нека започнем да инсталираме phpDocumentor. Отворете конзолата на Windows ( Win + r и въведете cmd ) и въведете 2 команди, които са описани на официалния уебсайт:

Ще се зареди и. След това имаме няколко варианта за развитие на събитията. Първо, всичко е наред, phpDocumentor е инсталиран и готов за работа (имате късмет ;)). Второ, изходът за грешка е: ГРЕШКА: не може да се разопакова. phpDocumentor-2.8.2.tgz:

Ако имате грешка, въведете следните 3 команди в конзолата:

Сега или инсталирайте PhpDocumentor 1.4.4 с командата (не препоръчвам да инсталирате тази версия, защото е остаряла):

Или инсталирайте PhpDocumentor 2.8.1 (аз го инсталирах), с командата:

След това инсталирането на PhpDocumentor трябва да успее:

Ако сте инсталирали PhpDocumentor 2, тогава можете спокойно да продължите към описанието на командите PhpDocumentor Commands.

Можете да премахнете phpDocumentor 2 с помощта на командата:

Ако решите да инсталирате PhpDocumentor 1, ето няколко команди за вас:

Създаване на документация. В конзолата въведете:

Инсталиране на PhpDocumentor с Composer

Внимание! Ще ви трябва Composer, за да инсталирате phpDocumentor. Ако не сте го инсталирали, инсталирайте го, като използвате статията: Инсталиране на Composer в Windows.

Създайте папка за PhpDocumentor като: D:/phpdoc/phpDocumentor. Той съдържа файл composer.json със следното съдържание:

След това имаме две опции за инсталиране. Първо щракнете с десния бутон върху файла и изберете Инсталиране на композитор. Втората опция, отворете конзолата на Windows (Win+r и въведете cmd), отидете до папката с файла composer.json и въведете командата за инсталиране на композитора:

И в двата случая в края на инсталацията ще видите следния прозорец:

Ако сте инсталирали phpDocumentor с помощта на контекстното меню (чрез щракване върху десния бутон на мишката), след това отворете конзолата на Windows (Win+r и въведете cmd) и отидете до папката, където е инсталиран phpDocumentor в папката your_path/vendor/bin. Ако първоначално сте инсталирали phpDocumentor през конзолата, отидете в папката /vendor/bin:

От тази папка можете лесно да използвате командата phpdoc за създаване на документация.

Извикването на phpDocumentor става с командата phpdoc.

Списък на командите на PhpDocumentor:

Генериране на проектна документация:

Пример за главната страница на генерираната документация:

Посочете шаблон за документация:

Получете списък с всички налични шаблони:

Това е всичко, наслаждавайте се на използването на PhpDocumentor

---