Wie kann man PHPDOC -Kommentar im phpdoc -Kommentar entkommen?
-
21-08-2019 - |
Frage
Ich würde gerne wissen, wie man Phpdoc -Kommentaren innerhalb eines Phpdoc -Kommentars entkommt.
Wie müsste ich zum Beispiel schreiben:
/**
* Some documentation...
*
* <code>
* /**
* * Example example phpdoc.
* */
* </code>
*/
Offensichtlich funktioniert das obige Beispiel nicht.
Ich habe versucht, das Sternchen mit *zu ersetzen, aber es wird einfach gut gedruckt " *" ...
Lösung
Entsprechend DOCBLOCK -Beschreibung Details, Sie können ab 1.2.0rc1 {@ *} schreiben */.
Zum Beispiel:
/**
* Simple DocBlock with a code example containing a docblock
*
* <code>
* /**
* * My sample DocBlock in code
* {@*}
* </code>
*/
Andere Tipps
Sie müssen verwenden @example
. Fügen Sie die folgenden Zeilen nach dem Tag hinzu </code>
@example /path/to/example.php How to use this function
@example anotherexample.inc This example is in the "examples" subdirectory
Sie können weitere Informationen finden hier. Sie müssen also anscheinend auch den Beispielcode in einer separaten Datei haben.
Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow