Как избежать комментария phpdoc в комментарии phpdoc?

Question

Я хотел бы знать, как избежать комментариев phpdoc в комментарии phpdoc.

Например, как бы мне написать это:

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

Очевидно, что приведенный выше пример не сработает.

Я попытался заменить звездочку на & # x2A;, но она просто красиво выведет "& # x2A;"...

Answer 1

В соответствии с описанием DocBlock, вы можете, начиная с 1.2.0rc1, написать {@*} для записи */.

Например:

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

Answer 2

Вам нужно использовать @example, Добавьте следующие строки после тега </code>

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

Вы можете найти больше информации здесь. Таким образом, вы, очевидно, должны иметь пример кода в отдельном файле.