Правильный синтаксис дляоризонт в phpDocumentor
Какой правильный синтаксис для @inheritDoc в phpDocumentor, если я просто хочу наследовать всю документацию от родительского? Может быть, более одного синтаксиса является правильным?
@inheritDoc{@inheritDoc}@inheritdoc{@inheritdoc}
Документация довольно расплывчатая, я думаю. PhpStorm, кажется, поддерживает их все, но, может быть, у меня возникнут проблемы при создании документов с некоторым синтаксисом?
Решение
Дочерний элемент должен автоматически наследовать почти все от своего родительского docblock без нужен этот тег. В противном случае все ваши методы реализации должны были бы снова и снова документироваться, ничего не получая от оригинальной документации интерфейса.
Просто унаследованный элемент без докблока должен автоматически наследовать все из родительского докблока.
@inheritdoc Единственная цель тега — помочь вам импортировать один вещь из родительского docblock — длинное описание этого родителя. Единственная причина, по которой ребенок не должен иметь это в наличии, — это то, что ребенок пошел вперед и имел собственный док-блок. Теперь ребенок должен все еще наследовать почти все от родительского docblock, не дублируя его … Кроме Длинное описание родителя. Если дочерний доклок по какой-то причине решил иметь свой собственный докблок, а также вы еще хотите унаследовать длинное описание родителя, то где вы положили @inheritdoc в дочернем docblock определяет, где появляется это родительское длинное описание. Таким образом, ребенок может иметь собственное краткое описание и длинное описание, и все же также включить длинное описание своего родителя в указанное место по отношению к детскому длинному описанию. Это единственная причина, по которой этот тег родился 🙂
Что касается автозаполнения IDE, я не могу сказать, что я видел согласованное поведение в IDE, когда дело доходит до этого тега. Кроме того, я видел проекты, в которых предполагается, что этот тег это причина эта информация унаследована от родительских docblocks даже случается.
Другие решения
Я ничего не знаю о поддержке IDE, кроме документация пишется как {@inheritDoc},