在 phpDoc 语法中定义命名空间答案

【问题标题】：Defining namespaces in phpDoc syntax在 phpDoc 语法中定义命名空间
【发布时间】：2011-06-08 17:27:58
【问题描述】：

谁能告诉我在 phpDoc 语法中定义 php 命名空间的正确方法是什么？或者，@package 在 phpDoc 中是否已弃用，因为命名空间或多或少定义了一个包？

如果没有，是否有一种通用的方法来记录文档所在的命名空间？

【问题讨论】：

标签： php phpdoc

【解决方案1】：

phpDoc 没有命名空间的概念，但您可以（并且可能应该）为它使用 @package。

您可以查看phplint documentation 以了解它们是如何格式化命名空间的。

【讨论】：

感谢您在其文档中引用使用命名空间格式的现有库。没找到，绝对有用！
PHPdoc Manual也是不错的资源
自从这个答案以来，事情发生了一些变化。 phpDoc 现在确实大量使用了命名空间的概念，但 phpDoc 文档没有定义它，因为它是一种 PHP 语言概念，在 PHP 5.3 中变得可控。 phpDoc 文档现在建议在 @package 上使用命名空间，其目的是在两者中具有相同的层次结构，这通常是这种情况。

【解决方案2】：

@package 应该在项目中每个文件的每个文档块中使用，您也可以使用@subpackage。 @package 没有被弃用，它是定义命名空间的正确方法。

【讨论】：

【解决方案3】：

你可以看看DocBlox；这是一个支持命名空间的 API 文档生成器。

为了更清楚地回答您的问题：据我所知，由于命名空间的发明，软件包被视为已弃用。如果您阅读 PSR-0 规范，您会看到它试图将包作为命名空间的第二部分提供；首先是供应商。

【讨论】：

【解决方案4】：

phpDoc 文档说：

@package 标签可以作为命名空间。命名空间提供了结构的功能细分 @package 标签可以在其中提供逻辑细分的元素以哪种方式可以将元素分组为不同的层次结构。

如果总体而言，逻辑和功能细分都是是否不建议使用 @package 标签来防止维护开销。

【讨论】：