Question

这很简单。当我一次定义多个变量时，我只想要一种更紧凑的方法来为类属性定义phpDoc块，目前我必须单独定义每个变量。例如，这是我目前的phpDoc方法 - 逐个，每个可见性的变化只能定义一个：

/** @var int */
public $x;

/** @var int */
public $y;

/** @var int */
public $z;

/** @var Dance */
public $foo;

如果我能将它们分组，那么看起来会更容易。我期待这样的事情是有效的，但似乎不是：

public
    /** @var int */
    $x,
    /** @var int */
    $y,
    /** @var int */
    $z,
    /** @var Dance */
    $foo;

我尝试了很多变化，包括尝试这个，这也不起作用：

/**
 * @var int
 * @var int
 * @var int
 * @var Dance
 */  

public $x, $y, $z, $foo;

这非常简单，但是我总是想知道这可能吗？

Answer 1

一般来说，phpDoc只是一个评论。因此，注释不能对PHP无效。

但是phpDoc对于工具（IDE或文档生成器）可能有效或无效。如果您遵循此标准@var，您的工具将“理解”（可能）您。此外，工具可以扩展此标准，检查文档。

实施例

class Foo
{
  /** @var string|null Should contain a description */
  protected $description = null;
}

甚至可以记录复合陈述：

class Foo
{
  /**
   * @var string $name        Should contain a description
   * @var string $description Should contain a description
   */
  protected $name, $description;
}

phpDoc是一个多属性

1 个答案: