2009-02-05 11 views
5

Me gustaría saber cómo escapar de los comentarios de phpdoc dentro de un comentario de phpdoc.¿Cómo escapar de un comentario de phpdoc en el comentario de phpdoc?

Por ejemplo, ¿cómo voy a tener que escribir esto:

/** 
* Some documentation... 
* 
* <code> 
* /** 
* * Example example phpdoc. 
* */ 
* </code> 
*/ 

Obviamente ejemplo anterior no funcionará.

he intentado reemplazar el asterisco de la & # X2A ;, pero se acaba de imprimir muy bien "& # X2A;" ...

Respuesta

7

De acuerdo con DocBlock Description details, puede, a partir de 1.2.0rc1, escribir {@ *} para escribir * /.

Por ejemplo:

/** 
* Simple DocBlock with a code example containing a docblock 
* 
* <code> 
* /** 
* * My sample DocBlock in code 
* {@*} 
* </code> 
*/ 
0

Es necesario utilizar @example. Añadir las siguientes líneas después de la etiqueta </code>

@example /path/to/example.php How to use this function 
@example anotherexample.inc This example is in the "examples" subdirectory 

Puede encontrar más información here. Por lo tanto, aparentemente también necesita tener el código de ejemplo en un archivo separado.

Cuestiones relacionadas