类实例的 DocBlock 文档

【问题标题】：DocBlock documentation for instances of classes类实例的 DocBlock 文档
【发布时间】：2015-04-16 07:24:46
【问题描述】：

您能否指导我如何使用 DocBloc 文档记录这段代码？

private $entityManager;

public function __construct($entityManager) {
    parent::__construct();
    $this->entityManager = $entityManager;
}

$entityManager 是 EnitiyManager 类的一个实例。

【问题讨论】：

标签： documentation phpdoc docblocks

【解决方案1】：

对于phpdoc，只有属性注解有用。

还添加了构造函数类型提示来检查类型。
但是考虑一下，构造函数注释不会带来任何新信息。

如需更多示例，最好查看 Github 上的一些框架源代码，例如Symfony

/**
 * @var EntityManager
 */
private $entityManager;


/**
 * @var EntityManager $entityManager
 */
public function __construct(EntityManager $entityManager) {
    parent::__construct();
    $this->entityManager = $entityManager;
}

【讨论】：

我知道构造函数方法的文档块是多余的。但是，如果不是，它会是什么样子？