Правильный синтаксис для inheritDoc в phpDocumentor

каков правильный синтаксис для @inheritDoc в phpDocumentor, если я просто хочу унаследовать всю документацию от родителя? Может быть более одного правильного синтаксиса?

  1. @inheritDoc
  2. {@inheritDoc}
  3. @inheritdoc
  4. {@inheritdoc}

документация довольно расплывчата, я думаю. PhpStorm, похоже, поддерживает все из них, но, возможно, у меня будут проблемы с созданием документов с некоторым синтаксисом?

18
inheritdoc php phpdoc

2 ответов

дочерний элемент должен автоматически наследовать почти все от своего родительского docblock без нужен этот тег. В противном случае все ваши методы реализации должны быть задокументированы снова и снова, не получая ничего из документации исходного интерфейса.

просто унаследованный элемент без docblock должны автоматически наследуют все из родительского docblock.

в @inheritdoc единственная цель тега-помочь вам импортировать один вещь из родительского docblock -- длинное описание этого родителя. Единственная причина, по которой ребенок не должен уже иметь это доступно, если ребенок пошел вперед и имел свой собственный docblock. Итак, ребенок!--3-->должны по-прежнему наследует почти все от своего родительского docblock без необходимости дублировать его... за исключением длинное описание родителя. Если дочерний docblock решил иметь свой собственный docblock почему-то,и вы еще хотите унаследовать длинное описание родителя, а затем, где вы положили @inheritdoc в дочернем docblock определяет, где появляется это родительское длинное описание. Таким образом, ребенок может иметь свое краткое описание и длинное описание, и все же и включите длинное описание своего родителя в указанное место по отношению к длинному описанию ребенка. это единственная причина, по которой этот тег был когда-либо родился : -)

что касается автозаполнения IDE, я не могу сказать, что я видел согласованное поведение между IDEs, когда дело доходит до этого тега. Кроме того, я видел проекты, где делается предположение, что этот тег причина эта унаследованная информация от родительских docblocks даже происходит.

40

Я ничего не знаю о поддержке IDE, кроме документация звучит как {@inheritDoc}.

1