Как создать учебник phpdoc / Расширенные страницы, чтобы дополнить прокомментированный код - PullRequest
Новая
       7

Как создать учебник phpdoc / Расширенные страницы, чтобы дополнить прокомментированный код

3 голосов
/ 07 августа 2009

Я пытаюсь сделать все возможное, чтобы phpdocumentor позволил мне использовать учебный формат DocBook для дополнения документации, которую он создает:

  1. Я использую Eclipse
  2. Я установил phpDocumentor через PEAR на машине с OSX
  3. Я могу запускать и автоматически генерировать код из моих классов php
  4. Это не отформатирует учебники - я не могу найти решение

Я пытался переместить файл примера .pkg по всей файловой структуре, во вложенных папках, используя имя, похожее на пакет, на который ссылается код ... Я действительно в растерянности - если кто-то может объяснить, ГДЕ они помещают файлы .pkg и другие файлы DocBook относительно кода, который они документируют, и того, как они запускают phpdoc для его форматирования. Я был бы признателен, сейчас я использую это: 

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output

Ответы [ 4 ]

3 голосов
/ 10 августа 2009

Я не ожидал, что отвечу на свой вопрос, но после 2 дней изнурительной боли и выходных, чтобы поэкспериментировать, кажется, что это проблема:

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

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output

Однако, если вы используете следующее: 

    phpdoc -o HTML:Smarty:HandS 
-d /path/to/code/classes/, /path/to/code/docs/tutorials/
-t /path/to/output

Он будет правильно форматировать ваши учебные пособия и расширенные документы, все что я сделал, это отбросил двойные кавычки , окружающие пути к каталогам. Одинарные кавычки не работают вообще - так как сам phpdoc упаковывает каталоги в двойные кавычки, если нет пробелов ... это действительно похоже на ошибку с phpdoc, и то же поведение происходит с веб-интерфейсом, поэтому это вопрос. Моя первоначальная попытка должна была сработать, но я не связался бы с разработчиками и довел ее до сведения.

Проблема решена.

1 голос
/ 07 августа 2009

Вы читали это ?

Он предлагает следующую схему пути: tutorials / package / package.pkg где package - это имя вашего пакета, вы сделали это таким образом?

0 голосов
/ 16 июня 2011

У меня возникла та же проблема с использованием .ini для конфигурации, но со мной проблема заключалась в том, что я помещал пробел между запятой и каталогом, в результате каталог не связывался с параметром -d .

Не работает: 

directory = {$lib}/Question,{$lib}/Error, {$path}/docs/tutorials

Рабочая: 

directory = {$lib}/Question,{$lib}/Error,{$path}/docs/tutorials

Надеюсь, это решит проблему для кого-то еще!

0 голосов
/ 22 ноября 2009

Да, использование вами двойных кавычек, вероятно, привело к разбору внутреннего аргумента времени выполнения phpDocumentor, в результате чего -d /path/to/code/classes будет одной парой аргумент / значение, не включая /path/to/code/docs/tutorials в качестве дополнительного значения каталога.

Как правило, я видел еще две проблемы, связанные с созданием учебников. Во-первых, каталог учебников - это не то, что ожидает phpDocumentor. Во-вторых, фактические файлы кода PHP не включены в выполнение. Я не забываю добавить словоблудие в руководство специально для этих двух сценариев .

...