Могу ли я дважды использовать @subpackage для phpDocumentor?

Например, у меня есть проект под названием «myproj» и подпакет под названием «utils», и в этом подпакете снова есть подпакет под названием «отладка».

Могу я сделать что-то подобное:?

/**
  * @package myproj
  * @subpackage utils
  * @subpackage debug
  * /

Заранее спасибо!

Решение

Также есть тег @category:

Тег @category используется для организации групп пакетов вместе.

Таким образом, вы можете использовать теги в следующем порядке: @category, @package, @subpackage. И если вам этого недостаточно, вы можете также использовать символы подчеркивания в именах.


package php documentation comments phpdoc
person ComFreek    schedule 05.02.2011    source источник
comment
Я предлагаю вам использовать @subpackage Utils_Debug, если вы используете такое пространство имен.   -  person Boris Guéry    schedule 05.02.2011

Ответы (2)


arrow_upward
2
arrow_downward

Я знаю, что вопрос довольно старый, но для любых Google Speeders - теги @subpackage устарели. Вместо этого используйте тег @package следующим образом:

@package [level 1]\[level 2]\[etc.]

См. Руководство по PHPDocumentor2: http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/package.html

person Petr Cibulka    schedule 06.04.2014
comment
Ух ты - ответ спустя более 3 лет! Спасибо. - person ComFreek; 06.04.2014
comment
Нет проблем, я сам искал информацию о PHPD2. :) - person Petr Cibulka; 06.04.2014

arrow_upward
1
arrow_downward

Большинство генераторов не распознают теги нескольких подпакетов. По соглашению используются символы подчеркивания или дефисы; или без сегментации ниже 2 уровней (пакет / подпакет)

См. http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.subpackage.pkg.html

person mvriel    schedule 29.05.2011
comment
Спасибо, но я нашел категорию тегов. Поэтому я использую @category, @package и, возможно, @subpackage. Мне этого достаточно;) - person ComFreek; 30.05.2011