Holas!!
Mi pregunta es simple: estoy tratando de escribir mis páginas PHP siguiendo la norma que requiere phpDocumentor para poder generar los manuales a partir del código.
Pues bien, he buscado y rebuscado en el sitio web de phpDocumentor, así como en su foro y manuales, pero no encuentro ninguna parte donde diga cómo se pueden documentar los errores de nuestro programa. O sea, si tenemos esto:
Código PHP:
/**
* Descripcion de mi funcion
*
* @param integer $numero : Este es un parametro de ejemplo de esta funcion
* @return boolean
*/
function MiFunction($numero)
{
...
}
...quiero saber si haciendo algo como esto (que no se puede, claro, por eso lo pregunto) podría documentar mis errores personalizados:
Código PHP:
/**
* Descripcion de mi funcion
*
* @param integer $numero : Este es un parametro de ejemplo de esta funcion
* @error ABC01 : Mensaje Ejemplo de Error
* @return boolean
*/
function MiFunction($numero)
{
...
}
O sea, si hay una tag que phpDocumentor reconozca como código de Error de nuestras funciones y clases, de modo que al generar el manual, no sólo aparezcan las variables, funciones y clases, sino también los código de errores que nosotros retornamos si se produce algun fallo al usar la funcion X, etc...
Uhm... Ahora que lo pienso... tal vez no se hayan preocupado de documentar los errores porque la mayoría usa el
die para demostrar que hay un fallo ¬¬....
Mm, pero como sea, igual lo pregunto por si las moscas.
Muchas gracias de antemano
