正确记录链接到phpdoc中的类的变量

时间:2013-12-25 00:08:58

标签: php phpdoc

我如何在phpdoc中正确记录这个?

我有一个链接到单独类的变量,如下所示:

public $link;
public function link($class) {
   $class = "\\Path\\To\\Class\\$class";
   $this->link = new $class;
}

我会在变量级别或功能级别实现phpdoc标记吗?除了学习phpdocs的正确实现之外,我还试图让代码在PHPStorm / Netbeans等IDE中识别出来。

1 个答案:

答案 0 :(得分:1)

此布局对于文档而言过于“运行时动态”。由于无法知道$ class参数指向哪一个类,因此$ link属性无法知道要列出哪个类作为其数据类型。这意味着没有IDE能够为您解决任何问题。

“记录”它的唯一方法就是这样,这是准确的,但是让你的IDE无需继续:

/** @var mixed */
public $link;
/**
 * @param string $class
 * @return void
 */
public function link($class) {
   $class = "\\Path\\To\\Class\\$class";
   $this->link = new $class;
}