Jak uciec od komentarza phpdoc w komentarzu phpdoc?

Question

Chciałbym wiedzieć, jak uciec od komentarzy phpdoc w komentarzu phpdoc.

Na przykład, w jaki sposób mam to napisać:

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

Oczywiście powyższy przykład nie będzie działać.

Próbowałem zastępując gwiazdka jest z & # X2A ;, ale to po prostu ładnie wydrukować "& # X2A," ...

Answer 1

Zgodnie z DocBlock Description details, można, począwszy od 1.2.0rc1, napisać {@ *}, aby napisać * /.

Na przykład:

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

Answer 2

Musisz użyć @example. Dodaj poniższe linie po tagu </code>

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

można znaleźć więcej informacji here. Więc najwyraźniej potrzebujesz przykładowego kodu również w osobnym pliku.