2

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

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

  1. $someGlobalVar不是类的 PHP 文件中的 decalren（它甚至可以是 unelared）。
  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 中似乎一切正常，但我不确定这是否是正确的方法......

任何人都可以确认它可以吗？

4

2 回答 2

1

您将记录我认为定义的变量，例如

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

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

反正我的意见。

于 2010-01-29T21:28:29.237 回答
1

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

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

从文档中：

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

于 2010-02-03T13:58:11.827 回答