phpDoc 一个多属性答案

【问题标题】：phpDoc a multi-propertyphpDoc 一个多属性
【发布时间】：2015-04-15 22:11:45
【问题描述】：

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

/** @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;

这很简单，但我一直想知道这可能吗？

【问题讨论】：

标签： php oop phpdoc

【解决方案1】：

一般来说，phpDoc 只是一个 cmets。因此，cmets 不能对 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;
}

【讨论】：