如何在phpdoc评论中逃避phpdoc评论?

时间:2009-02-05 13:22:34

标签: phpdoc

我想知道如何在phpdoc评论中逃避phpdoc评论。

例如,我怎么写这个:

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

显然上面的例子不起作用。

我尝试用&amp;#x2A;替换星号,但它会很好地打印“&amp;#x2A;”......

2 个答案:

答案 0 :(得分:7)

根据DocBlock Description details,您可以从1.2.0rc1开始编写{@ *}来编写* /。

例如:

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

答案 1 :(得分:0)

您需要使用@example。 在标记</code>

之后添加以下行
 @example /path/to/example.php How to use this function
 @example anotherexample.inc This example is in the "examples" subdirectory

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