PHP-Kommentarspezifikation

高洛峰
Freigeben: 2023-03-02 15:30:01
Original
979 Leute haben es durchsucht

@access
Verwendungsbereich: Klasse, Funktion, Variable, Definition, Modul
Dieses Tag wird verwendet, um die Zugriffsberechtigung von Schlüsselwörtern anzugeben: privat, öffentlich oder geschützt
@author
Geben Sie an Autor
@copyright
Verwendungsbereich: Klasse, Funktion, Variable, Definition, Modul, Verwendung
Geben Sie Copyright-Informationen an
@veraltet
Verwendungsbereich: Klasse, Funktion, Variable, Definition, Modul, constent , global, include
Zeigt nicht verwendete oder veraltete Schlüsselwörter an
@example
Dieses Tag wird verwendet, um den Inhalt einer Datei zu analysieren und hervorzuheben. PHPdoc versucht, den Dateiinhalt aus dem durch dieses Tag angegebenen Dateipfad zu lesen
@const
Verwendungsbereich: define
Wird verwendet, um die in PHP definierte Konstante anzugeben
@final
Verwendungsbereich: class ,function,var
gibt an, dass das Schlüsselwort eine endgültige Klasse, Methode oder ein Attribut ist und Ableitung und Änderung verboten sind.
@filesource
Ähnlich wie Beispiel, außer dass dieses Tag den Inhalt der aktuell analysierten PHP-Datei direkt liest und anzeigt.
@global
Gibt die globale Variable an, auf die in dieser Funktion verwiesen wird.
@ingore
wird verwendet, um das angegebene Schlüsselwort im Dokument zu ignorieren.
@license
entspricht < im HTML-Tag ;a>, zuerst die URL, dann der anzuzeigende Inhalt
Beispielsweise kann geschrieben werden als @license http://www .baidu.com Baidu
@link
ähnelt der Lizenz
, Sie können jedoch auch über den Link
@name
auf ein beliebiges Schlüsselwort im Dokument verweisen, um einen Alias ​​für das Schlüsselwort anzugeben.
@package
Verwendungsbereich: Seitenebene -> Definieren, Funktion, Einschließen
Klassenebene ->Klasse, Variable, Methoden
wird verwendet, um ein oder mehrere einer Gruppe zugewiesene Schlüsselwörter logisch zu kombinieren.
@abstrcut
Gibt an, dass die aktuelle Klasse eine abstrakte Klasse ist
@param
Gibt die Parameter einer Funktion an
@return
Gibt den Rückgabezeiger einer Methode oder Funktion an
@static
Zeigt an, dass der Guan Jianzi statisch ist.
@var
Geben Sie den Variablentyp an
@version
Geben Sie die Versionsinformationen an
@todo
Geben Sie die Bereiche an, die verbessert oder nicht implementiert werden sollten
@throws
Geben Sie an, dass diese Funktion möglicherweise eine Fehlerausnahme auslöst, die äußerst selten ist.
Wie oben erwähnt, müssen normale Dokument-Tags am Anfang jeder Zeile mit @ gekennzeichnet werden. Darüber hinaus gibt es auch ein Tag namens Inline-Tag, das {@} Ausdrücke verwendet Folgendes enthalten:
{@link}
Die Verwendung ist dieselbe wie bei @link
{@source}
Zeigt den Inhalt einer Funktion oder Methode an

Quelle:php.cn
Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn
Beliebte Tutorials
Mehr>
Neueste Downloads
Mehr>
Web-Effekte
Quellcode der Website
Website-Materialien
Frontend-Vorlage