如何在phpdoc注釋的代碼示例中保留空格

Question

我有這樣的代碼示例：

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

如果我將其添加到php doc中，它將變為：

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

如果我被前置標簽包圍，我會得到這個

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

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

我希望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
 */