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