【问题标题】:Properly documenting a variable that links to class in phpdoc正确记录链接到 phpdoc 中的类的变量
【发布时间】:2014-01-13 02:45:21
【问题描述】:

如何在 phpdoc 中正确记录这一点?

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

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

我会在变量级别还是函数级别实现 phpdoc 标签?除了学习 phpdocs 的正确实现外,我还试图让代码在 PHPStorm/Netbeans 等 IDE 中可识别。

【问题讨论】:

    标签: php phpdoc


    【解决方案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;
    }
    

    【讨论】:

      猜你喜欢
      • 2011-11-03
      • 2011-06-27
      • 2013-07-21
      • 1970-01-01
      • 1970-01-01
      • 2017-01-15
      • 2013-01-08
      • 1970-01-01
      • 2023-04-06
      相关资源
      最近更新 更多