如何将 PHP 代码块放入 PHPDoc DocBlock 中PHPDoc 使用 Github-Flavored Markdown 的示例

php documentation phpdoc comments markdown

2022-08-30 14:14:33

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

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

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

例如，此 DocBlock：

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

生成以下 HTML：

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

我哪里出错了？如何向我的 DocBlock 添加代码块？

答案 1

phpdocumentor 使用 markdown 的 github 变体。

添加代码的正确方法是：

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

答案 2

phpDocumentor手册说，对于描述

你可以根据Markdown来格式化你的文本，更具体地说是Github风格的Markdown。使用此格式，可以轻松使文本加粗，添加内联代码示例或轻松生成指向其他站点的链接。— DocBlocks 内部

PSR-5 PHPDoc表示描述

建议任何分析说明的应用程序都支持此字段的 Markdown 标记语言，以便作者可以提供格式设置和清晰的代码示例表示方式。— 描述

和那个标签

MUST支持Markdown作为格式化语言。由于Markdown的性质，在同一行或后续行上开始描述标签并以相同的方式解释它是合法的。— 标签

PHPDoc 使用 Github-Flavored Markdown 的示例

/**
 * This is a Summary.
 *
 * This is a Description. It may span multiple lines
 * or contain 'code' examples using the _Markdown_ markup
 * language.
 *
 * It's very easy to make some words **bold** and other 
 * words *italic* with Markdown. You can even 
 * [link to Google!](http://google.com).
 *
 * Here's an example of how you can use syntax 
 * highlighting with GitHub Flavored Markdown:
 *
 * ```
 * <?php
 * echo "Hello, world.";
 * ?>
 * ```
 * 
 * You can also simply indent your code by four spaces:
 * 
 *     <?php
 *     echo "Hello, world.";
 *     ?>
 *
 * @see Markdown
 *
 * @param int        $parameter1 A parameter description.
 * @param \Exception $e          Another parameter description.
 *
 * @\Doctrine\Orm\Mapper\Entity()
 *
 * @return string
 */
function test($parameter1, $e)
{
    ...
}