phpDocumentor @global 和 @name 问题

Question

第一天我使用 phpDocumentor ，到目前为止一切顺利，但我有一个问题，我在手册中没有发现...全局变量的文档。

如果出现以下情况，我将如何记录此代码：

1. $someGlobalVar 在类的 PHP 文件中不是 decalren（甚至可以不声明）。
2. $someGlobalVar 的声明如下：$someGlobalVar = array();（不像 phpDocumentor 手册中那样使用超全局数组）。

PHP 代码：

class myCustomClass
{
    private $someProperty;

    //I want to document the use of global var in this method
    public function getSomeProperty()
    {
        global $someGlobalVar;

        if (isset($someGlobalVar))
        {
            //...
        }
        else
        {
            //...
        }
    }
}

编辑： 我想按照手册所示记录这些全局变量，但我不确定如何/在哪里放置 @global 和 @name 标签。

编辑2：我最终在声明 getSomeProperty 之前使用了以下代码片段：

/**
 * Get some property based on the $someGlobalVar global.
 * @global array $someGlobalVar User defined array that bla bla bla.
 * @return mixed Return a result bla bla bla.
 */

我使用 phpDocumentor 语法，以便 NetBeans IDE 在源代码中显示内联帮助。在 NetBeans 中一切似乎都正确，但我不确定这是正确的方法...

任何人都可以确认它没问题吗？

Answer 1

我相信您会在定义变量的地方记录变量，例如，

/**
 * My var
 * @var array
 */
$someGlobalVar = array();

当您记录 API 及其功能时，您不需要在类方法中记录它。

无论如何我的意见。

Answer 2

由于 $someGlobalVar 是用户定义的，经过一些研究，我认为 @uses 是记录这一点的最合适的方式：

@uses $someGlobalVar User defined array that bla bla bla.

来自文档：

@uses 标签可用于记录
任何元素（全局变量，包括，
页面、类、函数、定义、方法、
变量）