Question

第一天我使用phpDocumentor并且到目前为止一直很好，但我有一个问题，我没有在手册中找到...全局变量的文档。

如果符合以下条件，我将如何记录此代码：

$ someGlobalVar在类的PHP文件中是而不是 decalren（它甚至可以被取消）。
$ 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标签可用于记录任何元素（全局变量，包括，页面，类，功能，定义，方法，变量）

phpDocumentor @global和@name问题

2 个答案: