Was sind die Standard-Annotationsmethoden in PHP?

In diesem Artikel werden sechs PHP-Kommentarmethoden vorgestellt.

Syntax für einzeilige PHP-Kommentare

Der gesamte Text rechts vom DE>//DE>-Symbol in einer Zeile wird als a betrachtet Kommentar, weil PHP Der Parser ignoriert die Zeile DE>//DE> Alles nach rechts. Wie folgt:

<span style="font-family: 微软雅黑, "Microsoft YaHei"; font-size: 14px;"><?php<br/>echo "Blabla.cn"; // 这是单行注释?><br/></span>

Sie können auch so schreiben, nur Kommentare in einer Zeile schreiben, keinen Code, wie folgt:

<span style="font-family: 微软雅黑, "Microsoft YaHei"; font-size: 14px;"><?php// 这是单行注释echo "Blabla.cn"; <br/>// 这是单行注释?><br/></span>

PHP Syntax für mehrzeilige Kommentare

Mehrzeilige PHP-Kommentare beginnen mit DE>/*DE> und enden mit DE>*/DE> Ende. Zwischen DE>/*DE> und DE>*/DE> können Sie mehrere Kommentarzeilen schreiben.

Das Beispiel sieht wie folgt aus: Der rote Teil ist der Inhalt mehrzeiliger Kommentare.

<span style="font-family: 微软雅黑, "Microsoft YaHei"; font-size: 14px;"><?php<br/>echo "Blabla.cn";/*<br/>这是多行注释<br/>这是多行注释<br/>*/?><br/></span>

Blockkommentare

Blockkommentare werden normalerweise verwendet, um Beschreibungen von Dateien, Methoden, Datenstrukturen und Algorithmen bereitzustellen. Blockkommentare werden am Anfang jeder Datei und vor jeder Methode platziert. Sie können auch anderswo verwendet werden, beispielsweise als Insider-Methoden. Blockkommentare innerhalb von Funktionen und Methoden sollten dieselbe Einrückung haben wie der Code, den sie beschreiben.

Am Anfang des Blockkommentars sollte eine Leerzeile stehen, um den Blockkommentar vom Code zu trennen, zum Beispiel:

/*
 
* 这里是块注释
*/

Blockkommentare können mit /*- beginnen, damit indent(1) sie als Code erkennen kann den Anfang des Blocks, ohne ihn neu anzuordnen.

/*-
 
* 如果想被忽略，可是使用特别格式的块注释
*
* one
* 　　two
* 　　　　three
*/

HINWEIS: Wenn Sie dies nicht tun Wenn Sie indent(1) verwenden, müssen Sie nicht /*- in Ihrem Code verwenden oder sich der Möglichkeit hingeben, dass andere indent(1) in Ihrem Code ausführen.
Einzeilige Kommentare

Kurze Kommentare können in einer Zeile angezeigt werden und haben die gleiche Einrückungsstufe wie der folgende Code. Wenn ein Kommentar nicht in einer Zeile geschrieben werden kann, verwenden Sie einen Blockkommentar. Einzeiligen Kommentaren sollte eine Leerzeile vorangestellt werden. Hier ist ein Beispiel für einen einzeiligen Kommentar im Code:

if (condition) {
 
/* 以下代码运行的条件 */
 
...
}

Endkommentare

Extrem kurze Kommentare können in derselben Zeile stehen wie der Code, den sie beschreiben, sollten jedoch durch genügend Leerzeichen getrennt sein Code und Kommentare. Wenn in einem großen Codeblock mehrere kurze Kommentare erscheinen, sollten sie dieselbe Einrückung haben.
Das Folgende ist ein Beispiel für einen nachgestellten Kommentar im Code:

if ($a == 2) {
 
return TRUE; /* 对单一条件的说明 */
} else {
return isPrime($a); /* 其余的条件 */
}

行末注释

注释界定符"//"，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；然而，它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子：

if ($foo > 1) {
 
// 第二种用法.
 
...
}
else {
return false; // 说明返回值的原因
}
//if ($bar > 1) {
 
//
// 　// 第三种用法
//　 ...
//}
//else {
// return false;
//}

文档注释

文档注释描述php的类、构造器，方法，以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中，一个注释对应一个类或成员。该注释应位于声明之前：

/**
 
* 说明这个类的一些 ...
*/
class Example { ...

注意

顶层(top-level)的类是不缩进的，而其成员是缩进的。

描述类的文档注释的第一行(/**)不需缩进；随后的文档注释每行都缩进1格(使星号纵向对齐)。

成员，包括构造函数在内，其文档注释的第一行缩进4格，随后每行都缩进5格。

文档注释不能放在一个方法或构造器的定义块中，因为程序会将位于文档注释之后的第一个声明与其相关联。

【相关课程：PHP视频教程】

Das obige ist der detaillierte Inhalt vonWas sind die Standard-Annotationsmethoden in PHP?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!