类 实例的 DocBlock 文档

Question

能否就如何使用 DocBloc 文档记录这段代码提供一些指导？

private $entityManager;

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

$entityManager 是 EnitiyManager class 的实例。

Answer 1

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

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

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

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


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