php - 如何将 PHP 代码块放入 PHPDoc DocBlock

Question

我正在使用 PHPDoc，并意识到您可以使用 markdown 向 DocBlock 添加一些格式。特别是，我注意到您可以使用反引号来突出显示内联代码。

但是，我似乎不知道如何将代码块添加到 DocBlock，因为使用 4 个空格似乎不起作用。

我尝试过使用 <code>和 <pre>同样，虽然这些标签确实出现在生成的文档中，但其中的代码会被 HTML 注释注释掉。

例如，这个 DocBlock:

/**
 * This is a test DocBlock
 *
 * <pre>
 *     <?php
 *         echo('hi');
 *     ?>
 * </pre>
 *
 * @return object[] An array of objects.
 */

生成此 HTML:

<pre>
    <!--?php echo('hi'); ?-->
</pre>

我哪里错了？如何将代码块添加到我的 DocBlock？

Answer 1

phpdocumentor 使用markdown 的github 变体。

添加代码的正确方法是:

/**
 * This is a test DocBlock
 *
 * ```php
 * echo('hi');
 * ```
 *
 * @return ...
 */