【问题标题】:PhpDoc: protected propertyPhpDoc:受保护的财产
【发布时间】:2016-07-29 06:39:16
【问题描述】:

是否可以使用 PhpDoc 声明 protectedprivate 类 @property?

/**
  * Class Node
  * @package app\models
  * @property string $name
  */
class Node
{

}

【问题讨论】:

  • 我可能是错的,但是为什么要说,那个类有一些属性,不能访问?
  • 您可能想要记录内部魔术方法/属性。

标签: php phpdoc


【解决方案1】:

我不这么认为。对于@property,隐含public,即使它是只读的或只写的。这些标签的意义在于记录无法推断的接口。私有/受保护变量实际上是类的内部变量,因此它只与子类相关,应该像他们已经知道一样编写。不过,您仍然可以在声明它之前立即留下一个普通的文档块。

【讨论】:

  • 如果出于某种原因要突出显示实际上不公开的魔法属性,您可以使用@internal 标签来解释为什么该属性值得突出显示。
猜你喜欢
  • 1970-01-01
  • 2017-01-30
  • 1970-01-01
  • 2012-06-22
  • 2019-02-14
  • 2013-02-05
  • 2012-06-15
  • 2020-09-09
  • 1970-01-01
相关资源
最近更新 更多