PHPPHPDoc


Sintaxis

  • @api
  • @autor [nombre] [<dirección de correo electrónico>]
  • @ copyright <descripción>
  • @deprecated [<"Versión semántica">] [: <"Versión semántica">] [<descripción>]
  • @ejemplo [URI] [<descripción>]
  • {@example [URI] [: <start> .. <end>]}
  • @inheritDoc
  • @interno
  • {@internal [descripción]}}
  • @license [<identificador SPDX> | URI] [nombre]
  • @ método [retorno "Tipo"] [nombre] (["Tipo"] [parámetro], [...]) [descripción]
  • @paquete [nivel 1] \ [nivel 2] \ [etc.]
  • @param ["Tipo"] [nombre] [<descripción>]
  • @ propiedad ["Tipo"] [nombre] [<descripción>]
  • @return <"Type"> [descripción]
  • @see [URI | "FQSEN"] [<descripción>]
  • @since [<"Versión semántica">] [<descripción>]
  • @throws ["Tipo"] [<descripción>]
  • @todo [descripción]
  • @uses [archivo | "FQSEN"] [<descripción>]
  • @var ["Type"] [element_name] [<description>]
  • @version ["Versión semántica"] [<descripción>]
  • @filesource - Incluye el archivo actual en los resultados del análisis phpDocumentor
  • @link [URI] [<description>] - La etiqueta de enlace ayuda a definir la relación o enlace entre elementos estructurales .

Observaciones

"PHPDoc" es una sección de la documentación que proporciona información sobre aspectos de un "Elemento estructural" - PSR-5

Las anotaciones de PHPDoc son comentarios que proporcionan metadatos sobre todos los tipos de estructuras en PHP. Muchos IDE populares están configurados de forma predeterminada para utilizar las anotaciones de PHPDoc para proporcionar información sobre el código e identificar posibles problemas antes de que surjan.

Si bien las anotaciones de PHPDoc no forman parte del núcleo de PHP, actualmente tienen el estado de borrador con PHP-FIG como PSR-5 .

Todas las anotaciones de PHPDoc están contenidas en DocBlocks que se demuestran mediante una multilínea con dos asteriscos:

/**
 *
 */

El borrador completo de los estándares PHP-FIG está disponible en GitHub .

PHPDoc Ejemplos relacionados