PHP Depend和@ package-annotations

时间:2010-02-03 18:10:23

标签: php

What's the point of package annotations?类似,我正在对我们源代码的一部分运行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.

这实际意味着什么,我该如何解决,以及在哪里?

1 个答案:

答案 0 :(得分:2)

来自PHPDocumentor for the @package annotation

的文档
  

包用于帮助您对相关元素进行逻辑分组。您编写类以将相关函数和数据组合在一起,并且phpDocumentor将文件(函数,定义和包含)的内容表示为“过程页面”。包用于将类和过程页面组合在一起,其方式与目录将相关文件组合在一起的方式相同。

例如,Zend Framework中的所有验证器都属于Zend_Validate包,因为从概念上讲,它们就是这样。当PHPDocumentor创建文档时,您可以浏览Zend_Validate包并查看其中的所有具体验证器类。

PHPDepend显然希望您使用注释来创建适当的文档(因此选项使用--bad-documentation)。检查我引用的页面,了解如何使用注释。