documentation - 类实例的 DocBlock 文档

Question

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

private $entityManager;

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

这$entityManager是 EnitiyManager 类的一个实例。

Answer 1

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

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

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

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


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