Kommentar-Tags, die jeder PHPer beherrschen sollte!

                                                       

Empfohlen: „PHP-Video-Tutorial“

Vorwort

Kommentar-Tags spielen eine sehr wichtige Rolle in Codekommentaren. Gute Kommentar-Tags können Ihnen ein besseres und komfortableres Erlebnis im Programmierprozess bieten, deshalb habe ich heute Ich werde diese Tags sortieren und in Form von Bildern und Texten anzeigen. Einerseits möchte ich diese Anmerkungs-Tags zusammenfassen und organisieren. Andererseits hoffe ich auch, dass jeder die Anmerkungs-Tags besser verstehen kann

Jeder möchte schönen Code schreiben. Vielleicht sind Sie nur einen Tag von schönem Code entfernt Abstrakte Klassenvariablen und -methoden

@accesspublic, private oder protectedZugriffs- und Nutzungsrechte des Dokuments @access private gibt an, dass das Dokument geschützt ist. ?? Version Veraltet im Dokument Methode @deprec@example/path/to/exampleDer Speicherort der extern im Dokument gespeicherten Beispieldatei. @Exception@global@ignoreIm Dokument angegebene Schlüsselwörter ignorieren@internalEntwicklungsteam intern. Informationen@link URLÄhnlich wie eine Lizenz, aber okay Detailliertere Informationen finden Sie im Dokument über den Link@nameVariablenalias@magicphpdoc.de-Kompatibilität@paket Der Name des gekapselten Pakets@param@returnso als zurückgegebener bool Beschreibung des Funktionsrückgabeergebnisses, wird im Allgemeinen nicht in Void-Funktionen (leeres Rückgabeergebnis) verwendet@seewie Class Login()jedes mit der Datei verknüpfte Element (globale Variablen, einschließlich Seiten, Klassen, Funktionen, Definitionen, Methoden, Variablen). @sinceVersionZeichnen Sie auf, wann an welchen Teilen des Dokuments Änderungen vorgenommen wurden.Statische Klassen und Methoden aufzeichnen

Viele der oben genannten Punkte müssen beim Erstellen von Dateien und Klassen tatsächlich hinzugefügt werden. Heute werde ich hauptsächlich die häufig verwendeten Tags erklären.

@param

Beschreibung

Parameter, die für Tags in Funktions- und Methodenkommentaren verwendet werden
Format @param [Typ] [Name] [<beschreibung>]</beschreibung>@param [Type] [name] [<description>]</description>
例如@param string title 文章标题

代码举例

@return

说明

返回值
格式@return [类型] []]
例如@return array 结果数组

代码举例

@deprecated

说明

不建议使用的、已过期的、将被删除的
格式@deprecated [] []
例如@deprecated 1.0.0 新版本将不再包含此函数
如果它是被其他方法所取代了，建议添加@see标记

代码举例

@see

说明

参考，类似@link，可与@deprecated联动
格式@see [url或完整方法名] []
例如@see yiibasedb::tableName() 旧方法table_name已弃用，请使用此方法替代

代码举例

@link

说明

链接，可用于辅助说明、引用文档等
格式@link [url] []
例如@link http://g.cn 不懂滚去问谷歌，别来烦我

代码举例

@link&@see区别

	Gleiche wie @deprecated
	Für Ausnahmen, die von Methoden im Dokument ausgelöst werden, können Sie auch auf @throws verweisen.
Typ: $globalvarname	Globale Variablen und zugehörige Methoden und Funktionen in das Dokument
	Geben Sie einen Alias ​​für eine Variable an
	Der Name des Pakets, das von einer Gruppe verwandter Klassen und Funktionen gepackt wird
z. B. $Benutzername Benutzername	Annotation mit variabler Bedeutung
		@static
		at Statische Variablen, die in Klassen und Funktionen verwendet werden
Zeigt Bereiche an, in denen Die Datei ist unvollständig oder muss verbessert werden

-	@see	@link
外部链接	√	√
内部程序	√	X

@var

说明

变量
格式@var [类型] [变量名] []
例如@var int id 用户id

变量列表

变量类型	说明
string	字符串
integer/int	number/int类型
boolean/bool	false/true
float/double	number/浮点数
object	对象实例
specifiedType	指定类
mixed	任意类型
array/specifiedType[]	数组，可以指定成指定类型的数组
resource	文件资源类型
void	无返回值
null	-
callable	可执行的回调函数
function	不一定能执行的方法
self/$this	当前实例

代码举例

1、在方法外的变量定义

2、在方法内的变量定义

@throws

说明

可能会抛出的错误类型
格式@throws [类型] []
例如@throws ExceptionZum Beispiel @param string title Artikeltitel

Codebeispiel

@return

Description

Return value🎜Format @return [Type] []]🎜Zum Beispiel @return array Result array🎜🎜Codebeispiel🎜🎜🎜🎜@deprecated🎜 🎜Description🎜 🎜Format, das nicht empfohlen wird, abgelaufen ist und gelöscht wird🎜@deprecated [<versionsnummer>] [<description>]</description></versionsnummer>🎜Zum Beispiel @deprecated Die neue Version 1.0. 0 enthält diese Funktion nicht mehr🎜Wenn sie durch andere Methoden ersetzt wird, wird empfohlen, das Tag @see hinzuzufügen🎜🎜Codebeispiel🎜🎜🎜🎜@see🎜🎜Erklärung🎜🎜Referenz, ähnlich wie @ Link, kann mit @deprecated verknüpft werden🎜Format @see [URL oder vollständiger Methodenname] []🎜Zum Beispiel @see yiibasedb::tableName() Die alte Methode table_name ist veraltet, bitte verwenden Sie stattdessen diese Methode 🎜 🎜Codebeispiele🎜🎜🎜 🎜@link🎜🎜Beschreibung🎜🎜Link, kann für Hilfsanweisungen, Referenzdokumente usw. verwendet werden.🎜Format @link [url] [<beschreibung>]</beschreibung>🎜Zum Beispiel @link http ://g.cn Wenn Sie es nicht verstehen, fragen Sie Google und stören Sie mich nicht🎜🎜Codebeispiele🎜🎜🎜🎜@link&@siehe Unterschied🎜-

@see	@link
Externer Link	√ td>	√
Internes Programm	√	X

🎜@var🎜🎜Description🎜🎜Variable🎜Format @var [Typ] [Variablenname] [<description>]</description>🎜Zum Beispiel @var int id user id🎜🎜Variablenliste🎜<table> <thead><tr class="firstRow"> <th>Variablentyp</th> <th>Beschreibung</th> </tr></thead> <tbody> <tr> <td>string</td> <td>String</td> </tr> <tr> <td>integer/int</td> <td>number/int type</td> tr></tr> <tr> <td>boolean/bool</td> <td>false/true</td> </tr> <tr> <td>float/double</td> <td>number/ Gleitkomma</td> </tr> <tr> <td>Objekt</td> <td>Objektinstanz</td> </tr> <tr> <td>specifiedType</td> <td>Angegebene Klasse </td> </tr> <tr> <td>gemischt</td> <td>Beliebiger Typ</td> </tr> <tr> <td>array/specifiedType[]</td> <td> Array, ja Geben Sie ein Array des angegebenen Typs</td> </tr> <tr> <td>Ressource</td> <td>Dateiressourcentyp</td> </tr> <tr> <td>void an </td> <td>Kein Rückgabewert</td> </tr> <tr> <td>null</td> <td>-</td> </tr> <tr> <td>aufrufbar td></td> <td>Ausführbare Rückruffunktion</td> </tr> <tr> <td>Funktion</td> <td>Methode, die möglicherweise nicht ausführbar ist</td> </tr> <tr> <td> self/ $this</td> <td>Aktuelle Instanz</td> </tr> </tbody> </table>🎜Codebeispiel🎜🎜1. Variablendefinition außerhalb der Methode🎜<img src="https:/%20/%20img.php.cn/upload/article/000/000/020/87cd2d1b97495b5e9a749375631c8717-5.png" alt="Kommentar-Tags, die jeder PHPer beherrschen sollte">🎜2. Variablendefinitionen innerhalb von Methoden🎜🎜<img src="https://img.php.cn/upload/article/000/000/020/87cd2d1b97495b5e9a749375631c8717-6.png" alt="Kommentar-Tags, die jeder PHPer beherrschen sollte">🎜🎜@throws🎜🎜 Beschreibung🎜🎜Die Typen von Fehlern, die ausgelöst werden können🎜Format <code>@throws [Typ] [<beschreibung>]</beschreibung>🎜Zum Beispiel: @throws Ausnahme🎜🎜🎜🎜                                                     🎜🎜 🎜🎜🎜

Das obige ist der detaillierte Inhalt vonKommentar-Tags, die jeder PHPer beherrschen sollte!. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!