Syntaxe correcte pour inheritDoc dans phpDocumentor
Quelle est la syntaxe correcte pour @inheritDoc dans phpDocumentor si je veux juste hériter toute la documentation du parent? Peut-être que plus d'une syntaxe est correcte?
@inheritDoc{@inheritDoc}@inheritdoc{@inheritdoc}
La documentation est assez vague je pense. PhpStorm semble les prendre en charge tous mais peut-être aurai-je du mal à générer les documents avec une partie de la syntaxe?
Un élément enfant devrait hériter automatiquement de presque tout de son docblock parent sans que ait besoin de cette balise. Sinon, toutes vos méthodes d'implémentation devraient être documentées à nouveau sans rien gagner par la documentation de l'interface d'origine.
Simplement, un élément hérité sans docblock devrait hérite automatiquement de tout du docblock de son parent.
Le seul but de la balise @inheritdoc Est de vous aider à importer ne chose depuis le docblock parent - la description longue de ce parent. La seule raison pour laquelle l'enfant ne devrait pas déjà disposer de cette information est que l'enfant est allé de l'avant et avait son propre docblock. Maintenant, l'enfant devrait hériter encore de presque tout de son docblock parent sans avoir à le dupliquer ... sauf celui du parent Longue description. Si le docblock enfant a choisi d'avoir son propre docblock pour une raison quelconque, et vous voulez toujours hériter de la description longue du parent, puis l'endroit où vous mettez @inheritdoc dans le docblock enfant détermine où cette description longue du parent apparaît . Ainsi, l'enfant peut avoir sa propre description courte et longue description, et toujours aussi inclure la description longue de son parent à un endroit spécifié par rapport à la description longue de l'enfant. C'est la seule raison pour laquelle cette balise est née :-)
En ce qui concerne IDE autocompletion, je ne peux pas dire que j'ai vu un comportement cohérent entre les IDE en ce qui concerne cette balise. De plus, j'ai vu des projets où l'hypothèse est faite que cette tag est la raison qui a même hérité des informations des docblocks parents.
Je ne sais rien du support IDE mais la documentation le définit comme {@inheritDoc}.