несколько подпакетов для phpdoc - PullRequest
2 голосов
/ 20 ноября 2008

Возможно ли, чтобы файл принадлежал нескольким подпакетам? Например:

/**
 * Name
 *
 * Desc
 *
 * @package    Core
 * @subpackage  Sub1
 * @subpackage  Sub2
 */

Спасибо! * * 1004

Ответы [ 3 ]

4 голосов
/ 21 ноября 2008

Похоже, что PHPDoc не позволяет вам делать это по причинам пространства имен. Из PHPDoc Docs :

ПРИМЕЧАНИЕ. Тег @subpackage предназначен для категоризации элементов с фактическим значением @package. Поскольку сам PHP не позволяет иметь две функции с одинаковыми именами в одном и том же скрипте, PhpDocumentor также требует, чтобы все имена в @package были уникальными ... это означает, что @subpackage не допускает дальнейшего "разделения имен" внутри @package. Что он делает, так это позволяет уровень визуальной группировки / разделения элементов внутри этого @ пакета.

Похоже, что @package в PHPDoc - это способ псевдо-пространства имен ваших функций и классов, а @subpackage просто для категоризации. Вы пытались добавить более одного подпакета? Если да, каковы были результаты?

2 голосов
/ 10 июля 2012

Для этого вы можете использовать следующее:

* @package popcap\system\cache

Это создаст иерархию пакетов при компиляции PHPdocs.

1 голос
/ 13 марта 2010

http://pear.php.net/package/PHP_UML/

Кажется, что он неплохо справляется с несколькими тегами @subpackage - он даже сгенерирует html-документацию, как это делает phpDocumentor - хотя, похоже, он не так стильно, как phpDocumentor.

Он также использует дополнительный подпакет, показывая его в сгенерированном UML-диагаре.

...