我可以为phpDocumentor使用两次“@subpackage”吗?

时间:2011-02-05 17:57:13

标签: php documentation comments package phpdoc

例如,我有一个名为“myproj”的项目和一个名为“utils”的子包,在这个子包中又有一个名为“debug”的子包。

我可以这样做吗??

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

提前致谢!


解决方案

还有标签@category:

  

@category标记用于组织一组包。

因此您可以按以下顺序使用标签:@category,@ package,@ subpackage 如果这对你来说还不够,可以在名字中使用下划线。

2 个答案:

答案 0 :(得分:2)

我知道这个问题已经过时了,但对于任何谷歌发言人来说, @subpackage标签现已弃用。请以下列方式使用@package标记:

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

检查PHPDocumentor2手册:http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/package.html

答案 1 :(得分:1)

大多数生成器不会理解多个子包标签。公约要么使用下划线,要么使用连字符;或不分割低于2级(包/子包)

请参阅:http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.subpackage.pkg.html