Урок - Создание документации

Главная » Курсы » Курс Документирование PHP-кода » Урок - Создание документации

Обучающий онлайн курс
Документирование PHP-кода

Лицензия: Копирование запрещено.
↑ Документирование PHP-кода
  Урок - Создание документации  
← Предыдущий урок
Урок - Знакомство с документированием phpDoc
 		  Следующий урок →
Урок - Теги в phpDocumentor

Идём в папку user, в которой создаём файл myconf.ini, в нём будет наша конфигурация к phpDocumentor:
[Parse Data]
	title = Название документации
	hidden = false
	parseprivate = on
	javadocdesc = on
	defaultpackagename = Главная
	target = Исходящая директория
	directory = Входящая директория
	output=HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,HTML:frames:earthli,HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,HTML:frames:DOM/phphtmllib,HTML:Smarty:PHP
	sourcecode=on


Возвращаемся опять в корень и запускаем phpdoc.bat. После этого в исходящей директории вы увидите несколько вариантов документаций. Выбираем ту которая больше Вам по душе, и указываем только её в параметре output нашей конфигурации.

Оформить шаблон вы можете в папке phpDocumentor/Converters/Формат/Тип/templates/class.tpl, путь не точный, и зависит от выбранного формата и типа.
Если вы собираетесь использовать русский язык — читаем фикс
↑ Документирование PHP-кода
  Урок - Создание документации  
← Предыдущий урок
Урок - Знакомство с документированием phpDoc
 		  Следующий урок →
Урок - Теги в phpDocumentor