我玩弄PHPDoc的，并已经意识到，你可以用降价来一些格式添加到文档块。我特别注意到，你可以使用回蜱突出内嵌代码。

不过，我似乎无法弄清楚如何代码块添加到文档块，如使用4位似乎并没有工作。

我已经尝试使用<code>和<pre>过了，而这些标签也出现在生成的文档，里面它们的代码变得与HTML注释注释掉。

例如，该文档块：

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

产生这个HTML：

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

我要去哪里错了？我怎么能一个代码块添加到我的文档块？

Answer 1:

phpDocumentor的使用降价GitHub的变种。

添加代码的正确方法，则是：

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

Answer 2:

该手册的phpDocumentor说，对于说明

您可以根据您的格式化文本降价，更具体Github上味的降价。使用这种格式很容易让你的文本加粗，加内嵌代码示例或容易产生其他网站的链接。 - 内部文档块

在PSR-5 PHPDoc的说，对说明

任何解析描述应用建议支持该领域的降价标记语言，以便它有可能为作者提供格式化和代表代码示例的一条明路。 - 说明

和标签

必须支持降价的格式化语言。由于降价的性质，它是合法的，开始在同一个标签或下一行的描述，并以同样的方式解释。 - 标签

使用Github上味减价PHPDoc的实施例

/**
 * 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)
{
    ...
}

Answer 3:

我不认为你应该加入<?php标签，我会假设它会剥夺其关闭的解析。看到作为PHPDoc的你也许可以跳过产品总数。

尝试

 * <code>
 *         echo('hi');
 * </code>

Answer 4:

你应该能够使用： -

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

文章来源: How do I put blocks of PHP code into a PHPDoc DocBlock