开发者

Can I use twice "@subpackage" for phpDocumentor?

开发者 https://www.devze.com 2023-02-08 23:39 出处:网络
For example I have a project called \"myproj\" and a subpackage called \"utils\" and in this subpackage there\'s again a subpackage called \"debug\".

For example I have a project called "myproj" and a subpackage called "utils" and in this subpackage there's again a subpackage called "debug".

Can I do something like that: ?

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

Thanks in advance!


Solution

There is also the tag @category:

The @category tag is used to organize groups of packages together.

So you can use the tags in the following order: @category, @package, @subpackage And if that isn't enough for you, can开发者_StackOverflow社区 could use also underscores in the names.


I know the question is quite old, but for any google speeders - @subpackage tags are now deprecated. Use @package tag instead in a following manner:

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

Check PHPDocumentor2 manual: http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/package.html


Most generators will not understand multiple subpackage tags. Convention is either to use underscores or hyphens; or not segmenting below 2 levels (package / subpackage)

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

0

精彩评论

暂无评论...
验证码 换一张
取 消