PHPDoc对@ property-read和@ property-write的解释

Question

我认为我的问题标题很明确。我需要@property-read和@property-write的解释。这是关于phpDoc http://manual.phpdoc.org/HTMLframesConverter/default/的链接，但在那里我找不到关于它的解释。只有@property

的解释

Answer 1

关于魔法属性的

Here's a good explanation。

基本上，@property-write被解释 - 顾名思义 - 是一种只写属性。例如，Eclipse中的代码完成就是利用它。如果您的魔法属性foo被声明为“只写”，则当您键入$a = $this->f时，它不会显示在代码完成中。

Answer 2

@property标记是phpDocumentor手册中记录的内容。此标记仅在类docblock中用于记录“魔术”属性/变量，即未在代码中定义的属性/变量，因此不能为“docblock'd”。

现在，当你想强调一个特定的“魔术变量”是只读的（不可写）时，你会使用@ property-read。如果你有一个只写（不可读）的“魔术变量”，你可以使用@ property-write。当然，我无法想象无法读取的只写变量，但由于技术上可以这样做，因此可以使用@ property-write来记录它。

@property的这两个“子标签”在您链接到上面的@property页面上进一步解释。