Wie bewahren Leerzeichen in Codebeispiel in phpdoc Kommentar

Question

ich ein Codebeispiel wie dieses:

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

Wenn ich es in die PHP-doc fügen Sie es in diese verwandelt:

$ this-> someConfig ['Einstellungsname'] = ['Modell' => 'foo \ bar \ baz', 'Spalten' => ['bla', 'blo', 'bleh'], 'Sortierreihenfolge' => 'asc', ' defaultsort '=>' bla ',];

wenn ich es durch Pre-Tags umgeben bekomme ich diese

$ this-> someConfig [ 'Setting'] = [
'Modell' => 'foo \ bar \ baz',
'columns' => [ 'bla', 'blo', 'bleh'],
'sortorder' => 'ASC',
'defaultsort' => 'bla',
];

was näher ist aber immer noch nicht was ich will.

Ich möchte die Whitespace-Formatierung erhalten bleiben.

Wie erreiche ich das?

Answer 1

Sie können dies erreichen, indem Sie anstelle eines Sternchens vor dem kommentierten Code ein   Zeichen verwenden. Umschließen Sie Ihren Code in <pre> Tags, um sicherzustellen, dass neue Zeilen beibehalten werden, oder verwenden Sie <BR> Tags nach jeder Zeile.

Es wird in ein Leerzeichen umgewandelt, und alle Leerzeichen nach dem ursprünglichen   Zeichen werden eingeschlossen.

Mit dem   Charakter wird den zusätzlichen Vorteil, Ihr Beispielcode haben kann, ohne irgendwelche seltsamen Dinge auftauchen oder kopiert und eingefügt werden, um

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

gereinigt werden