如何在PHP(Java)Doc中标记数组值类型?

时间:2010-06-17 10:37:57

标签: php class arrays javadoc phpdoc

可能有点难以解释,所以我将给出一些示例代码。请注意,我正在使用NetBeans IDE(最新版)。

class Dummy {
    public function say(){ }
}
/**
 * Builds dummy class and returns it.
 * @return Dummy The dummy class.
 */
function say_something(){
  return new Dummy();
}
$s=say_something();

在netbeans中进行开发时,我可以在输入“$ s->”后按ctrl + space来调用自动完成。 在随后的提示窗口中,有项“say()”。这是因为javadoc说say_something返回一个Dummy和NetBeans解析的Dummy类,知道它有一个名为“say()”的方法。

到目前为止一切顺利。

我的问题是数组。示例代码如下:

/**
 * Builds array of 2 dummy classes and returns it.
 * @return Array The dummy class. (*)
 */
function say_something2(){
  return array(new Dummy(),new Dummy());
}
$s=say_something2();

如果我再次使用“$ s [0] - >”尝试自动完成的事情相反,我没有得到Dummy类的方法。这是因为在JavaDoc中我只说它是一个数组而不是值'type

所以问题是,是否有任何JavaDoc语法,作弊,什么允许我告诉JavaDoc在数组中期望什么类型的变量?

1 个答案:

答案 0 :(得分:2)

你做不到。请参阅文档here