PHP規(guī)范的注釋方法是什么

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

PHP 單行注釋語(yǔ)法

在一行中所有 DE>//DE> 符號(hào)右面的文本都被視為注釋?zhuān)?因?yàn)?PHP 解析器忽略該行 DE>//DE> 右面的所有內(nèi)容。如下:

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

你也這樣這樣寫(xiě)，一行只寫(xiě)注釋?zhuān)粚?xiě)代碼，如下：

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

PHP 多行注釋語(yǔ)法

PHP 多行注釋以 DE>/*DE> 開(kāi)頭，以 DE>*/DE> 結(jié)束。在 DE>/*DE> 和 DE>*/DE> 之間，可以寫(xiě)多行注釋。

示例如下，紅色部分就是多行注釋的內(nèi)容。

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

塊注釋

塊注釋通常用于提供對(duì)文件，方法，數(shù)據(jù)結(jié)構(gòu)和算法的描述。塊注釋被置于每個(gè)文件的開(kāi)始處以及每個(gè)方法之前。它們也可以被用于其他地方，比如方法內(nèi)部。在功能和方法內(nèi)部的塊注釋?xiě)?yīng)該和它們所描述的代碼具有一樣的縮進(jìn)格式。

塊注釋之首應(yīng)該有一個(gè)空行，用于把塊注釋和代碼分割開(kāi)來(lái)，比如：

/*
 
* 這里是塊注釋
*/

塊注釋可以以/*-開(kāi)頭，這樣indent(1)就可以將之識(shí)別為一個(gè)代碼塊的開(kāi)始，而不會(huì)重排它。

/*-
 
* 如果想被忽略，可是使用特別格式的塊注釋
*
* one
* 　　two
* 　　　　three
*/

注意：如果你不使用indent(1)，就不必在代碼中使用/*-，或?yàn)樗丝赡軐?duì)你的代碼運(yùn)行indent(1)作讓步。
單行注釋

短注釋可以顯示在一行內(nèi)，并與其后的代碼具有一樣的縮進(jìn)層級(jí)。如果一個(gè)注釋不能在一行內(nèi)寫(xiě)完，就該采用塊注釋。單行注釋之前應(yīng)該有一個(gè)空行。以下是一個(gè)代碼中單行注釋的例子：

if (condition) {
 
/* 以下代碼運(yùn)行的條件 */
 
...
}

尾端注釋

極短的注釋可以與它們所要描述的代碼位于同一行，但是應(yīng)該有足夠的空白來(lái)分開(kāi)代碼和注釋。若有多個(gè)短注釋出現(xiàn)于大段代碼中，它們應(yīng)該具有相同的縮進(jìn)。
以下是一個(gè)代碼中尾端注釋的例子：

if ($a == 2) {
 
return TRUE; /* 對(duì)單一條件的說(shuō)明 */
} else {
return isPrime($a); /* 其余的條件 */
}

行末注釋

注釋界定符"//"，可以注釋掉整行或者一行中的一部分。它一般不用于連續(xù)多行的注釋文本；然而，它可以用來(lái)注釋掉連續(xù)多行的代碼段。以下是所有三種風(fēng)格的例子：

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

文檔注釋

文檔注釋描述php的類(lèi)、構(gòu)造器，方法，以及字段(field)。每個(gè)文檔注釋都會(huì)被置于注釋定界符/**...*/之中，一個(gè)注釋對(duì)應(yīng)一個(gè)類(lèi)或成員。該注釋?xiě)?yīng)位于聲明之前：

/**
 
* 說(shuō)明這個(gè)類(lèi)的一些 ...
*/
class Example { ...

注意

頂層(top-level)的類(lèi)是不縮進(jìn)的，而其成員是縮進(jìn)的。

描述類(lèi)的文檔注釋的第一行(/**)不需縮進(jìn)；隨后的文檔注釋每行都縮進(jìn)1格(使星號(hào)縱向?qū)R)。

成員，包括構(gòu)造函數(shù)在內(nèi)，其文檔注釋的第一行縮進(jìn)4格，隨后每行都縮進(jìn)5格。

文檔注釋不能放在一個(gè)方法或構(gòu)造器的定義塊中，因?yàn)槌绦驎?huì)將位于文檔注釋之后的第一個(gè)聲明與其相關(guān)聯(lián)。

以上是PHP規(guī)范的注釋方法是什么的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！