Где воздух гор - там тишина снегов, молчание камней и дремлет сила

Программирование Web

Установка PHPDocumentator на сервере Ubuntu

2018-07-11 06:20:17






PHPDocumentator прекраснный инструмент для генерации документации в web проекте.

1. Лучше всего устанавливать через composer. В команндной строке запускаем:

sudo composer require "phpdocumentor/phpdocumentor:2.*"


2. После завершения установки нам нужно перейти в корень проекта. Для настройки генерации документации создаем там файл с настройками для phpDocumentor phpdoc.dist.xml. Пример файла выглядит так:


<?xml version="1.0" encoding="UTF-8" ?>
 
<phpdoc>
 
<parser>
 
<target>data/output</target>
 
<extensions>
 
<extension>php</extension>
 
<extension>phtml</extension>
 
<extension>module</extension>
 
<extension>inc</extension>
 
</extensions>
 
</parser>
 
<transformer>
 
<target>data/output</target>
 
</transformer>
 
<files>
 
<directory>.</directory>
 
</files>
 
</phpdoc>
3. Далее заходим в корень проекта и запускаем:

phpdoc -d path/myproject -f path/to/an/additional/file -t path/myoutput/folder

настройки командной строки:

-d директория или директории, где находится проект для генерации документации
-f дополнительный файл или файлы, которые нужно включить в документацию

-t целевая директория, в которую будет сгенерирована документация
На этом все.Дополнительная информация на сайте: https://www.phpdoc.org/

Здесь нет комментариев


Новый комментарий:
























Яндекс.Метрика