代码之家  ›  专栏  ›  技术社区  ›  Glen Solsberry

php dependent和@package注释

php
  •  3
  • Glen Solsberry  · 技术社区  · 14 年前

    类似 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 回复  |  直到 14 年前
        1
  •  2
  •   Gordon Haim Evgi    14 年前

    从文件中 PHPDocumentor for the @package annotation

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

    例如,zend框架中的所有验证器都属于zend-validate包,因为从概念上讲,它们只是这个包。当phpdocumentor创建文档时,您可以浏览到包zend_validate并查看其中的所有具体的validator类。

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