PHP規范的注釋方法是什么

小編給大家分享一下PHP規范的注釋方法是什么，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

PHP 單行注釋語法

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

<?php
echo "Blabla.cn"; // 這是單行注釋?>

你也這樣這樣寫，一行只寫注釋，不寫代碼，如下：

<?php// 這是單行注釋echo "Blabla.cn"; 
// 這是單行注釋?>

PHP 多行注釋語法

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

示例如下，紅色部分就是多行注釋的內容。

<?php
echo "Blabla.cn";/*
這是多行注釋
這是多行注釋
*/?>

塊注釋

塊注釋通常用于提供對文件，方法，數據結構和算法的描述。塊注釋被置于每個文件的開始處以及每個方法之前。它們也可以被用于其他地方，比如方法內部。在功能和方法內部的塊注釋應該和它們所描述的代碼具有一樣的縮進格式。

塊注釋之首應該有一個空行，用于把塊注釋和代碼分割開來，比如：

/*
 
* 這里是塊注釋
*/

塊注釋可以以/*-開頭，這樣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規范的注釋方法是什么的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！