Sintaxis correcta para inheritDoc en phpDocumentor
inheritdoc c# (2)
No sé nada sobre el soporte de IDE, pero la phpdoc.org/docs/latest/guides/… deletrea como {@inheritDoc} .
¿Cuál es la sintaxis correcta para @inheritDoc en phpDocumentor si solo quiero heredar toda la documentación de los padres? Tal vez más de una sintaxis es correcta?
@inheritDoc-
{@inheritDoc} -
@inheritdoc -
{@inheritdoc}
La documentación es bastante vaga, creo. PhpStorm parece ser compatible con todos ellos, pero ¿quizás tenga problemas para generar los documentos con algo de sintaxis?
Un elemento hijo debería heredar automáticamente casi todo de su bloque de documentos principal sin necesidad de esta etiqueta. De lo contrario, todos los métodos de implementación tendrían que ser documentados nuevamente sin obtener nada por la documentación de la interfaz original.
Simplemente, un elemento heredado sin un bloque de documentos debería heredar automáticamente todo del bloque de documentos de su padre.
El único propósito de la etiqueta @inheritdoc es ayudarlo a importar una cosa desde el bloque de documentos primario: la Descripción larga de ese padre. La única razón por la que el niño todavía no debería tener esto disponible es si el niño siguió adelante y tuvo su propio bloque de documentos. Ahora, el niño todavía debe heredar casi todo de su bloque de documentos principal sin tener que duplicarlo ... excepto la Descripción larga del padre. Si el bloque de documentos hijo eligió tener su propio bloque de documentos por algún motivo, y aún desea heredar la Descripción larga del padre, entonces, al colocar @inheritdoc en el bloque de documentos hijo, se determina dónde aparece esa Descripción larga del padre. Por lo tanto, el niño puede tener su propia Descripción breve y Descripción larga, y también incluir la Descripción larga de su padre en un lugar específico en relación con la Descripción larga del niño. Esta es la única razón por la que esta etiqueta nació :-)
Con respecto al autocompletado de IDE, no puedo decir que he visto un comportamiento consistente en los IDE cuando se trata de esta etiqueta. Además, he visto proyectos en los que se supone que esta etiqueta es la razón por la que incluso se produce la información heredada de los bloques de padres.