32

私はPHPDocで遊んでいて、マークダウンを使用してDocBlockにフォーマットを追加できることに気づきました。特に、バックティックを使用してインラインコードを強調表示できることに気付きました。

ただし、4つのスペースを使用しても機能しないように見えるため、コードのブロックをDocBlockに追加する方法がわからないようです。

私も使ってみましたが<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にコードのブロックを追加するにはどうすればよいですか？

4

4 に答える 4

30

phpdocumentor は、マークダウンの github バリアントを使用します。

コードを追加する適切な方法は次のとおりです。

/**
 * This is a test DocBlock
 *
 * ```php
 * echo('hi');
 * ```
 *
 * @return ...
 */
于 2014-04-03T13:58:54.153 に答える
17

phpDocumentor マニュアルには、説明について

Markdown、より具体的にはGithub-flavored Markdownに従ってテキストをフォーマットできます。この形式を使用すると、テキストを太字にしたり、インライン コード例を追加したり、他のサイトへのリンクを簡単に生成したりできます。— DocBlock 内

PSR-5 PHPDocは説明について述べています

説明を解析するすべてのアプリケーションは、このフィールドの Markdown マークアップ言語をサポートすることをお勧めします。これにより、作成者は書式設定とコード例を表す明確な方法を提供できます。—説明

そしてそのタグ

フォーマット言語として Markdown をサポートしなければなりません。Markdown の性質上、同じ行または後続の行でタグの記述を開始し、同じように解釈することは合法です。—タグ

Github-Flavoured Markdown を使用した 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)
{
    ...
}
于 2016-10-14T07:04:12.143 に答える
11

タグを追加するべきではないと思います<?php。解析時に削除されると思います。phpdoc として見ると、おそらくまとめてスキップできます。

試す

 * <code>
 *         echo('hi');
 * </code>
于 2012-07-31T13:37:54.903 に答える
2

あなたが使用できるはずです： -

/**
 * This is a test DocBlock
 *
 * <pre>
 *     &lt;?php
 *         echo('hi');
 *     ?&gt;
 * </pre>
 *
 * @return object[] An array of objects.
 */
于 2012-07-31T13:38:10.283 に答える