Heim > Artikel > Backend-Entwicklung > So kommentieren Sie Klassenspezifikationen in PHP
@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
Copyright-Informationen angeben
@deprecated
Verwendungsbereich: Klasse, Funktion, Variable, Definition, Modul, constent , global, include
Zeigt unbenutzte oder veraltete Schlüsselwörter an
@example
Dieses Tag wird verwendet, um einen Teil des Dateiinhalts zu analysieren und hervorzuheben. Phpdoc wird versuchen, den Inhalt der Datei aus dem durch dieses Tag angegebenen Dateipfad zu lesen 🎜>Verwendungsbereich: Klasse, Funktion, Variable
Gibt an, dass das Schlüsselwort eine endgültige Klasse, Methode, ein Attribut und ein Verbot ist Ableitung und Modifikation.
@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 dem
html Tag Das in
ist zuerst die URL, gefolgt vom anzuzeigenden Inhalt
Zum Beispiel BaiduKann als @license http://www.baidu.com Baidu
@link Ähnlich wie eine Lizenz geschrieben werden, Sie können jedoch auch über den Link
auf ein beliebiges Schlüsselwort im Dokument verweisen @name
Geben Sie einen Alias für das Schlüsselwort an.
@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
Spezifiziert einen Parameter einer
Funktion @return
Gibt an, dass der Rückgabezeiger einer Methode oder Funktion
@statisch
ist, was darauf hinweist, dass das Schlüsselwort statisch ist.
@var
Variablentyp angeben@version Versionsinformationen angeben
@todo
Bereiche angeben, die verbessert oder nicht implementiert werden sollten
@throws
Angeben dass diese Funktion möglicherweise Fehlerausnahmen auslöst, die äußerst selten sind
Wie oben erwähnt, müssen normale Dokument-Tags am Anfang jeder Zeile mit @ markiert werden. Darüber hinaus gibt es auch ein Tag namens Inline-Tag, das {@} Ausdrücke enthält die folgenden Typen:
{@link}
Die Verwendung ist die gleiche wie bei @link
{@source}
Zeigt den Inhalt einer Funktion oder Methode an
Das obige ist der detaillierte Inhalt vonSo kommentieren Sie Klassenspezifikationen in PHP. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!