Как сохранить пробелы в образце кода в 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'] = [
'модель' => 'Foo \ бар \ Базь
'столбцы' => [ 'бла', 'BLO', 'BLEH'],
'SortOrder' => 'по возрастанию',
'DefaultSort' => 'бла',
];

который ближе, но все еще не тот, который я хочу.

Я хочу, чтобы форматирование пробелов сохранялось.

Как это достичь?

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 
*/