Hispanopedia Wiki
Articulo de referencia

PHPDoc

PHPDoc es una adaptación del formato Javadoc para el lenguaje de programación PHP . Sigue siendo un estándar informal para comentar código PHP, pero está en proceso de formaliza...

Hispanopedia WikiContenido en espanolLectura gratuita

PHPDoc es una adaptación del formato Javadoc para el lenguaje de programación PHP . Sigue siendo un estándar informal para comentar código PHP, pero está en proceso de formalización. [ 1 ] Permite que generadores de documentos externos como phpDocumentor , que es la implementación estándar de facto, [ 1 ] generen documentación, y ayuda a algunos IDE como Zend Studio , NetBeans , JetBrains PhpStorm , ActiveState Komodo Edit e IDE , PHPEdit y Aptana Studio a interpretar tipos de variables y otras ambigüedades en el lenguaje de tipado flexible y a proporcionar una mejor finalización de código , sugerencias de tipo y depuración.

PHPDoc admite la documentación tanto de código orientado a objetos como de código procedimental .

El 13 de agosto de 2013, el Grupo de Interoperabilidad de Marcos de PHP comenzó a escribir una especificación formal (PSR) para PHPDoc. [ 1 ]

Ejemplo

/** * Obtiene todos los nodos de imagen. * * @param \DOMNode $node La instancia de \DOMDocument * @param boolean $strict Si el documento debe ser válido * * @return \DOMNode */ public function getImageNodes ( \DOMNode $node , $strict = true ) : \DOMNode { // ... }

Véase también

Referencias

  1. 1 2 3 PHP-FIG: Borrador de trabajo de PSR - https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md
  • phpDocumentor.org