PHP規範的註解方法有哪些？

這篇文章介紹了六種PHP的註解方式，大家一起來學習吧！

PHP 單行註解語法

#在一行中所有DE>//DE> 符號右邊的文字都被視為註釋， 因為PHP解析器忽略該行 DE>//DE> 右面的所有內容。如下:

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

你也這樣寫，一行只寫註釋，不寫程式碼，如下：

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

PHP 多行註解語法

PHP 多行註解以DE>/*DE> 開頭，以 DE>*/DE> 結束。在 DE>/*DE> 和 DE>*/DE> 之間，可以寫多行註解。

範例如下，紅色部分就是多行註解的內容。

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

區塊註解

區塊註解通常用於提供對文件，方法，資料結構和演算法的描述。區塊註解被置於每個文件的開始處以及每個方法之前。它們也可以被用於其他地方，例如方法內部。在函數和方法內部的區塊註解應該和它們所描述的程式碼具有一樣的縮排格式。

區塊註解之首應該有一個空白行，用來把區塊註解和程式碼分割開來，例如： 

/*
 
* 这里是块注释
*/

區塊註解可以以/*-開頭，讓indent(1)可以將之辨識為一個程式碼塊的開始，而不會重排它。

#

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

注意：如果你不使用indent (1)，就不必在程式碼中使用/*-，或為他人可能對你的程式碼執行indent(1)作讓步。
單行註解

短註解可以顯示在一行內，並與其後的程式碼具有相同的縮排層級。如果一個註解不能在一行內寫完，就該採用區塊註解。單行註解之前應該有一個空白行。以下是一個程式碼中單行註解的範例：

#

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

#尾端註解

######極短的註解可以與它們所要描述的程式碼位於同一行，但是應該有足夠的空白來分開代碼和註釋。若有多個短註釋出現於大段程式碼中，它們應該具有相同的縮排。 ###以下是一個程式碼中尾端註解的範例： #########################

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视频教程】

以上是PHP規範的註解方法有哪些？的詳細內容。更多資訊請關注PHP中文網其他相關文章！