¿Cómo describir una función en PHP?

Los comentarios son algo fundamental para tener un control exclusivo de una aplicación en un futuro cuando nos toque modificar algo, sobre todo si son proyectos grandes, existe una notación para hacer esto y que sea compatible con PHPDoc, los parámetros son los siguientes:

  • @abstract
  • @access (public|private)
  • @author Nombre [Email] [, Nombre [Email]]
  • @brother (function(), $variable)
  • @const[ant] descripción
  • @deprec[ated] label
  • @exclude label
  • @final
  • @global
  • @include descripción
  • @link URL [descripción]
  • @magic descripción
  • @module label
  • @modulegroup label
  • @param[eter] (object objectname|type) [$varname] [descripción]
  • @return (object objectname|type) [$varname]
  • @see [(class|module:]function()|$varname [,[(class|module:J]function()|$varname]
  • @since label
  • @static
  • @throws exception [, exception]
  • @todo descripción
  • @var[iable] (object objectname|type) [$varname] [descripción]
  • @version label
  • Comentarios