Question

我有一个这样的代码示例：

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

如果我将它添加到php doc，它就变成了这个：

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

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

$ this-＆gt; someConfig ['settingname'] = [
  'model'=＆gt; '富\酒吧\巴兹'，
  'columns'=＆gt; [ 'BLA'， 'BLO'， '的Bleh']，
  '排序顺序'=＆GT; 'ASC'，
  'defaultsort'=＆gt; '喇嘛'，
  ];

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

我希望保留whitespacing格式。

我如何实现这一目标？

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注释中保留代码示例中的空格

1 个答案: