Как избежать комментария 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. Добавьте следующие строки после тега

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

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