如何在 phpdoc 注释的代码示例中保留空格

Question

我有这样的代码示例：

$this->someConfig['settingname'] = [
                                    'model' => 'foo\bar\baz',
                                    'columns' => ['bla','blo','bleh'],
                                    'sortorder'=> 'asc',
                                    'defaultsort' => 'bla',
                                    ];

如果我将它添加到 php 文档中，它会变成这样：

$this->someConfig['settingname'] = [ 'model' => 'foo\bar\baz', 'columns' => ['bla','blo','bleh'], 'sortorder'=> 'asc', 'defaultsort' => 'bla', ];

如果我用前置标签包围它，我会得到这个

$this->someConfig['settingname'] = [
'model' => 'foo\bar\baz',
'columns' => ['bla','blo','bleh'],
'sortorder'=> 'asc',
'defaultsort' => 'bla',
];

哪个更接近但仍然不是我想要的。

我希望保留空白格式。

我该如何实现？

Answer 1

您可以通过在注释代码前使用星号而不是   字符来实现此目的。还要将您的代码包装在 <pre> 标签中以确保保留换行符，或者在每行之后使用 <BR> 标签。

它将翻译成一个空白字符，并且将包括初始   字符之后的所有空白字符。

使用字符会有额外的好处，您可以复制和粘贴示例代码，而不会出现任何奇怪的东西或需要清理

 /** 
 * My code sample
 * <pre>
 &nbsp; $this->someConfig['settingname'] = [
 &nbsp;                                   'model' => 'foo\bar\baz',
 &nbsp;                                   'columns' => ['bla','blo','bleh'],
 &nbsp;                                   'sortorder'=> 'asc',
 &nbsp;                                   'defaultsort' => 'bla',
 &nbsp;                                   ];
 * </pre>
 * bla bla bla
 */

如何在 phpdoc 注释的代码示例中保留空格

How preserve whitespace in code sample in phpdoc comment

php

eclipse

phpdoc