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

Question

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

例如，我应该如何编写以下内容：

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

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

我试图用*替换星号，但它只会漂亮地打印出"*"...

- Tader

Answer 1

根据文档块描述细节，从1.2.0rc1版本开始，您可以写{@*}以写入*/。

例如：

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

- Tader

---

是否有一个完整的字符串列表需要进行转义？到目前为止，我了解到 @ 必须用 \@ 进行转义，而 */ 必须表示为 {@*}。这是全部吗，还是还有其他的？ - Danon

目前在PHPStorm中，这些转义字符都无法正常工作。 - undefined

Answer 2

你需要使用@example。 在</code>标签后添加以下行。

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

你可以在这里找到更多信息。 所以显然你需要将示例代码放在一个单独的文件中。

- Léo Léopold Hertz 준영