Tags sobre PHPDocumentor

Este post va dirigido a los que por lo menos se han leído algo de la documentación que hay en la página de PHPDocumentor que publiqué en el post anterior.

Bueno aquí les dejo una seria de tags interesantes que pueden utilizar en sus archivos de código para su documentación.

• @category: es usado para organizar grupos de paquetes juntos. Por ejemplo si dentro de un paquete tenemos varios subpaquetes podemos organizarlos por categoría. Ej.
  @package paquete
  @category categoria1
  class foo{}
  @package paquete
  @category categoria2
  class foo{}
  Allí le estamos diciendo que las dos clases pertenecen a un mismo paquete, sólo que a categoría diferentes. Esto puede ser útil para organizar bien tu código.
• @example: hace un enlace con un documento que puede se ejemplo para lo que se está documentando. La extensión del documento debe estar definidad dentro del phpdocumentor.ini. Si el archivo (ejemplo un archivo .php) entonces phpdocumentor genera un highlight (lo genera en html) del código fuente del archivo.
• @final: usada para un método, clase, etc. que nunca va a ser modificada, o sea es su versión final.
• @filesource: sólo puede ser usada en el primer DocBlock (bloque de documentación). Toma el código y genera un hightlight de tu código.
  
  
• @internal: es usado para crear dos tipos de documentación, ya sea una para uso privado y otra para uso público por ejemplo. La documentación que esta con el tag @internal se presenta sólo si activamos la opción de parse @access private y @internal (en modo web) o con los comandos -pp en modo consola.
• @license: puede ser usado para documentar cualquier elemento. En el colocas una url donde se encuentra dicha licencia y nombre para el url.
  Ej. /**
  * Muestra
  * http://opensource.org/licenses/gpl-license.php'>GNU Public License
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  */
  
• @name: phpDocumentor reconoce el nombre del tag en las variables globales dentro de los DocBlocks (en conjunto con @global) para así asignarle el valor de @name en vez de $GLOBLAS['var'].
  Ej. /**
  * @global variable $GLOBALS['var1']
  * @name var1
  */
  $GLOBALS['var1']
  Entonces en la documentación generada no saldría el nombre como mixed $GLOBALS['var'] sino como mixed var1.
  

En el siguiente post seguiré con más tags bien interesantes para la documentación en PHPDocumentor.