Документные блоки уровня страницы и шаблоны phpdocumentor

У меня действительно тяжелое время, чтобы заставить работать phpDocumentor 2.

У меня есть несколько файлов в процедурном стиле, которые должны быть задокументированы. Единственное, что я нашел для этого, это использовать докблоки на уровне страниц, но похоже, что они больше не работают правильно в phpDocumentor версии 2.

Связанный вопрос по stackoverflow показывает, что другие работают в той же проблеме. В этом вопросе есть два предложения:

  1. Добавить namespace к файлам, которые должны быть документированы
  2. По состоянию на выпуск phpDoc 910 использовать шаблон abstract или же new-black

К сожалению, я тоже не могу устроиться на работу.

  1. Когда я добавляю пространство имен, само пространство имен отображается в документе, но не в содержимом блока документов.
  2. Когда я выбираю другой шаблон (я пытался zend, abstract а также new-black) с phar-версии phpDoc 2 я получаю сообщение об ошибке PHP Warning: XSLTProcessor::transformToUri(): No stylesheet associated to this object in phar, Видимо это известная проблема.

РЕДАКТИРОВАТЬ:

Я на шаг впереди. Я установил PEP-версию phpDocumentor и опробовал каждый доступный шаблон. Но я все еще далек от достижения цели: доклоковые блоки на уровне страницы в сгенерированной документации.
Шаблоны делятся на две категории:

  • clean, responsive, responsive-twig а также old-ocean: Они не выводят docblocks уровня страницы в сгенерированной документации.
  • abstract, new-black а также zend: У них есть документ по файлу раздел, в котором показана ожидаемая документация на уровне файлов. Но им не хватает нескольких ресурсов (файлов и изображений .js), поэтому они выглядят одинаково и работают некорректно (на панели навигации нет функции развернуть-свернуть). Я заглянул в их git-репозиторий, и файлы, похоже, отсутствуют даже там.

На данный момент мне просто интересно, смотрю ли я в правильном направлении: кажется немыслимым, что невозможно получить документацию, показывающую docblocks на уровне файлов, из-за серьезных регрессий и ошибок в phpDocumentor 2.

Если я действительно ошибаюсь, пожалуйста, предложите мне, как получить ценную документацию из моего проекта PHP. Если я на правильном пути, пожалуйста, помогите мне понять, какая важная часть головоломки мне не хватает.

7

Решение

Задача ещё не решена.

Другие решения

Других решений пока нет …

По вопросам рекламы ammmcru@yandex.ru
Adblock
detector