CODEWITHSUNDEEP
phpdoc
Tader
Tader

Reputation: 26882

How to escape phpdoc comment in phpdoc comment?

I would like to know how to escape phpdoc comments within a phpdoc comment.

For example, how would I have to write this:

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

Obviously above example won't work.

I tried replacing the asterisk's with &#x2A;, but it will just nicely print "&#x2A;"...

Upvotes: 7

Views: 1637

Answers (2)

Tader
Tader

Reputation: 26882

According to DocBlock Description details, you can, as of 1.2.0rc1, write {@*} to write */.

For example:

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

Upvotes: 10

L&#233;o L&#233;opold Hertz 준영
L&#233;o L&#233;opold Hertz 준영

Reputation: 141320

You need to use @example. Add the following lines after the tag </code>

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

You can find more info here. So you apparently need to have the example code in a separate file too.

Upvotes: 0

Related Questions