如何在phpdoc注释中转义phpdoc注释？

Question

我想知道如何在phpdoc注释中转义phpdoc注释。

例如，我该如何编写以下代码：

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

显然上面的例子是行不通的。

我尝试将星号替换为*，但它将很好地打印出"*"...

Answer 1

根据DocBlock Description details的说法，从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

你可以找到更多信息here。因此，您显然也需要将示例代码放在一个单独的文件中。