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'd».

Теперь, когда вы хотите подчеркнуть, что определенная «магическая переменная» доступна только для чтения (не для записи), вы должны использовать @ property-read. Если у вас есть «магическая переменная», доступная только для записи (не читаемая), вы должны использовать @ property-write. Конечно, у меня возникли проблемы с представлением переменных, предназначенных только для записи, которые не могут быть прочитаны, но, поскольку технически это возможно, @ property-write доступен для вас, чтобы документировать это.

Эти два "подтега" @property описаны ниже на странице @property, на которую вы ссылались выше.