Tags sobre PHPDocumentor 2
Published by danilo04 on June 14th, 2007 in php
Siguiendo con la explicación de algunos tags que pueden utilizar en PHPDocumentor les dejo aquí unos cuantos.
- @param: indica el tipo de variable y una descripción de un parámetro de una función. Puedes asignar varios tipos de datos a un parámetro, por ejemplo integer y booleano.
Ej. @param integer|boolean @var1
La barra ( | ) se utiliza para separar los tipos de datos asignados a dicha variable. - @return: el tag return es usado para los métodos con valor de retorno. @returns es el alias de @return y cualquiera de los dos puede ser usado. El tipo de dato debe ser uno soportado por PHP, un nombre de clase o la palabra "mixed" (sin las comillas). Al igual que @param también asignar varios tipos de datos usando la barra ( | ). Si asignas un nombre de clase PHPDocumentor va a crar un link automáticamente enlanzando a la documentación de dicha clase.
- @see: es usado para documentar cualquier elemento (variable global, clase, función, etc). Sirve para referenciar ya sea a una clase padre o a una función de una clase hija, etc.
- @since: no sirve para referenciar desde que versión del archivo de código se encuentra presente el elemento (cualquier elemento ya se una función de una clase etc.).
- @static: es usado para declarar un método estático de una clase. Estos métodos son llamados sin necesidad de crear una instancia de objeto.
- @staticvar: lo mismo que static pero este se aplica a las variables estáticas de la clase. Puede llevar dos parámetros que son el tipo de datos y una pequeña descripción.
Ej. @staticvar string nombre del estudiante - @subpackage: trabajo junto con el tag @package. Hace un trabajo similar o parecido al tag @category.
- @access: define el tipo de acceso de la variable. Si es pública, privada o protected. Para que las variables privadas sean documentadas por PHPDocumentor hay que activar la opción de Parse @access private and @internal/{@internal}} en la configuración de la aplicación web, o si estas en consola utiliza -pp como parámetro.
- @todo: planea un nuevo cambio en un elemento que todavía no va a ser implementado. PHPDocumentor muestra dicho string (la información) sin alterar alguna palabra. Funciona para cualquier tipo de elemento.
- @var: se utiliza para documentar una variable de clase. El tipo de datos debe ser uno tal que se soportado por PHP, un tipo de clase o la palabra "mixed" (sin las comillas).
- @version: para indicar en que versión del archivo de código se encuentra actualmente. Usa un string cualquiera como parámetro.
Enviar un comentario nuevo