代码之家  ›  专栏  ›  技术社区  ›  Tader

如何在phpdoc comment中转义phpdoc comment?

  •  5
  • Tader  · 技术社区  · 17 年前

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

    例如,我将如何编写以下内容:

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

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

    我试着用&替换星号#x2A;,但它只会很好地打印“&x2A;”。。。

    2 回复  |  直到 17 年前
        1
  •  8
  •   Tader    16 年前

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

    例如:

    /**
     * Simple DocBlock with a code example containing a docblock
     *
     * <code>
     *  /**
     *   * My sample DocBlock in code
     *   {@*} 
     * </code>
     */
    
        2
  •  0
  •   Léo Léopold Hertz 준영    17 年前

    你需要使用 @example . 在标记后面添加以下行 </code>

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

    你可以找到更多信息 here

    推荐文章