phpdoc - 如何在 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

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