Я добавляю docblocks в свой код и разрешаю большую часть ошибок сборки и предупреждений, которые скрипт phpDocumentor сгенерировал и поместил в файл errors.html.
Тем не менее, у меня есть последний «класс» предупреждений в моей текущей сборке документации – я получаю предупреждение для каждого класса, который я зарегистрировал в своем приложении, который наследуется от внешней библиотеки (в данном случае Zend).
Есть ли способ остановить предупреждения, такие как Warning - Class AMH_Controller_Action parent Zend_Controller_Action not found из присутствия? Как сообщить phpDoc, что родитель из внешней библиотеки и, возможно, ссылку на ссылку на документацию Zend?
Сам phpDocumentor не имеет собственного варианта для обработки этого варианта использования. То, что я делал в прошлом, заключалось в создании фиктивного файла, который содержит пустые объявления классов для всех «не найденных» классов, помеченных этими классами, таких как «@package DoNotDocument», и использовал аргумент runtime –packageoutput [1] без перечисления «DoNotDocument» в список пакетов для включения в выходные документы. Конечно, это взломать, но эффект заключается в следующем:
a) избегать «не найденных» предупреждений (потому что класс сейчас «существует»),
b) не создавать какие-либо документы для фиктивных классов.
/** * @package DoNotDocument */ class Zend_Controller_Action {} phpdoc -d ./src -t ./docs -po MyPackage1,MyPackage2
Теперь подумайте над своими документами, если ваши классы действительно расширяют классы ZF. Не имея phpDocumentor для анализа этих источников ZF, ваши документы API для ваших классов не покажут, какие методы и т. Д. Унаследованы от этих родителей ZF. Если бы это была моя база кода, я бы разрешил phpDocumentor анализировать файлы ZF, но избегал бы иметь классы ZF, задокументированные, не перечисляя их вложенное значение @package (например, «Zend_Controller») в аргументе runtimeoutputout.