La syntaxe correcte pour inheritDoc dans phpDocumentor
Quelle est la bonne syntaxe pour @inheritDoc dans phpDocumentor si je veux juste d'hériter de la totalité de la documentation de parent? Peut-être plus d'une syntaxe est correcte?
@inheritDoc
{@inheritDoc}
@inheritdoc
{@inheritdoc}
La documentation est assez vague, je pense. PhpStorm semble à l'appui de tous, mais je vais peut-être avoir de la difficulté à générer de la doc avec certains de la syntaxe?
OriginalL'auteur Borek Bernard | 2014-10-24
Vous devez vous connecter pour publier un commentaire.
Un élément enfant devrait être automatiquement hériter à peu près tout de son parent docblock sans besoin de cette balise. Sinon, tous vos méthodes de mise en œuvre devraient être documentés de tout recommencer à zéro, sans avoir quoi que ce soit par l'interface d'origine de la documentation.
Simplement, hérité d'un élément sans un docblock devrait héritent automatiquement tout de l'un de ses parents docblock.
La
@inheritdoc
de l'étiquette unique objectif est de vous aider à importer un chose de la mère docblock -- qui parent la Description Longue. La seule raison pour laquelle l'enfant ne doit pas déjà avoir cette disposition est si l'enfant est allé de l'avant et a sa propre docblock. Maintenant, l'enfant devrait encore être hérite presque tout de son parent docblock sans avoir à dupliquer... sauf le parent de la Description Longue. Si l'enfant docblock choisi d'avoir son propre docblock pour une raison quelconque, et vous encore souhaitez hériter d'un parent est Longue Description, puis l'endroit où vous mettez@inheritdoc
de l'enfant docblock détermine l'endroit où le parent Longue Description s'affiche. Ainsi, l'enfant peut avoir son propre Description Courte et Longue Description, et encore aussi inclure l'un de ses parents, la Longue Description dans un endroit en ce qui concerne l'enfant, la Longue Description. C'est la seule raison de cette balise était jamais né 🙂À l'égard de l'IDE d'auto-complétion, je ne peux pas dire que j'ai vu de la cohérence du comportement à travers IDEs quand il s'agit de cette balise. De plus, j'ai vu les projets où l'hypothèse est faite que cette balise est la raison pour que les informations héritées du parent docblocks arrive même de.
@inheritDoc
est à portée de main dans les anciennes bases de codes de dire à ses lecteurs que la documentation est manquant intentionnellement. La Documentation des générateurs n'ont pas besoin de cela, mais l'homme en regardant le code dans un éditeur / sur Github faire. (C'est apparemment appelé explicitement dans le projet de norme).OriginalL'auteur ashnazg
Je ne sais rien à propos de l'IDE, mais de soutenir la la documentation sorts comme
{@inheritDoc}
.{@inheritdoc}
manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/...En plus de docs.phpdoc.org la documentation de l'orthographe comme
{@inheritDoc}
, il traite de l'utilisation de cette balise explicitement, en remplaçant tous contenu de la DocBlock avec celui du parent/de l'interface (voir le rouge "important" paragraphe), et de faire la distinction entre l'original inline{@inheritDoc}
balise qui comprend la description de la mère, et un nouveau potentiel@inheritDoc
tag, qui remplace tout le contenu (et qui est déjà utilisé dans ce sens par certains clients).OriginalL'auteur Fahmi