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

Question

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

Answer 1

这是对魔法属性的一个很好的解释.

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

Answer 2

@property 标签是 phpDocumentor 手册中记录的内容。此标记仅用于类 docblock 中以记录“神奇”属性/变量，即未在代码中定义的属性/变量，因此不能被“docblock”。

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

@property 的这两个“子标签”在上面链接到的 @property 页面上有更详细的解释。