Search code examples
phpdoc

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;"...


Solution

  • 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>
     */