Как и в чем смысл аннотаций пакета? , Я запускаю pdepend против раздела нашего исходного кода, ища проблемы. Однако он выплевывает следующее:
The parser doesn't detect package informations within the analyzed project, please check the documentation blocks for @package-annotations or use the --bad-documentation option.
Что это на самом деле означает, как я могу это исправить и где?
Из документации PHPDocumentor для аннотации @package
Пакеты используются, чтобы помочь вам логически группировать связанные элементы. Вы пишете классы для группировки связанных функций и данных вместе, а phpDocumentor представляет содержимое файлов (функции, определяет и включает) как «процедурные страницы». Пакет используется для группировки классов и процедурных страниц вместе таким же образом, что вместе файлы каталогов группируются вместе.
Например, все валидаторы в Zend Framework относятся к пакету Zend_Validate, потому что концептуально это именно так. Когда PHPDocumentor создает документацию, вы можете перейти к пакету Zend_Validate и просмотреть все конкретные классы валидатора.
PHPDepend, по-видимому, хочет, чтобы вы использовали аннотацию для создания надлежащей документации (отсюда и использование --bad-documentation
). Проверьте страницу, которую я цитировал, чтобы посмотреть, как использовать аннотации.