类的实例的DocBlock文档

Question

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

private $entityManager;

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

$entityManager是EnitiyManager类的一个实例。

Answer 1

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

还添加构造函数typehint以检查类型 但请注意，构造函数注释不会带来任何新信息。

有关更多示例，检查Github上的某些框架源是很好的，例如： Symfony

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


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