2012-02-21 9 views
5

Ho incontrato un problema con i nomi dei nomi PHP 5.3 e Doxygen.Come disabilitare la sintassi del comando slash in Doxygen

Esempio:

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

Doxygen mi dà i seguenti avvisi:

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

Cosa posso fare per risolvere questo problema o disattivare \ comandi e utilizzare solo i comandi @

risposta

5

Prova la fuga le vostre barre rovesciate, ovvero utilizzare

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

\\ è in realtà un comando doxygen che stampa solo un backslash.

Vedi anche Documenting PHP with Doxygen: The Pros and Cons:

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

Questo non è così grande, perché poi il doppio-barra sarà visibile per gli utenti che stanno leggendo la fonte di documentazione (ad esempio, il file di intestazione), e potrebbe confondere loro. –

Problemi correlati