2012-02-21 6 views
5

He tenido un problema con el espaciado de nombres de PHP 5.3 y los comentarios de Doxygen.Cómo deshabilitar la sintaxis del comando slash en Doxygen

Ejemplo:

/** 
* Sample Method 
* 
* @param string $output 
* @return \Project\Lib\Rest 
*/ 

Doxygen me da las siguientes advertencias:

warning: Found unknown command `\Project' 
warning: Found unknown command `\Lib' 
warning: Found unknown command `\Rest' 

¿qué puedo hacer para solucionar este problema o desactivar \ comandos y sólo utilizar los comandos de @Command

Respuesta

5

Intenta escapar sus barras diagonales inversas, es decir, use

/** 
* Sample Method 
* 
* @param string $output 
* @return \\Project\\Lib\\Rest 
*/ 

\\ es en realidad un comando doxygen que simplemente imprime una barra diagonal inversa.

Ver también Documenting PHP with Doxygen: The Pros and Cons:

/** 
* Sample Method 
* 
* @param string $output 
* @return Project::Lib::Rest 
*/ 
+0

Esto no es tan grande porque entonces la doble barra será visible para los usuarios que sólo están leyendo la fuente de documentación (por ejemplo, el archivo de cabecera), y podría confundir ellos. –

Cuestiones relacionadas