1. 程式人生 > >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";
/*
這是多行註釋
這是多行註釋
*/
?>

4.1 塊註釋

塊註釋通常用於提供對檔案,方法,資料結構和演算法的描述。塊註釋被置於每個檔案的開始處以及每個方法之前。它們也可以被用於其他地方,比如方法內部。在功能和方法內部的塊註釋應該和它們所描述的程式碼具有一樣的縮排格式。


塊註釋之首應該有一個空行,用於把塊註釋和程式碼分割開來,比如:



/*

* 這裡是塊註釋
*/


塊註釋可以以/*-開頭,這樣indent(1)就可以將之識別為一個程式碼塊的開始,而不會重排它。



/*-

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




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

短註釋可以顯示在一行內,並與其後的程式碼具有一樣的縮排層級。如果一個註釋不能在一行內寫完,就該採用塊註釋。單行註釋之前應該有一個空行。以下是一個程式碼中單行註釋的例子:



if (condition) {


/* 以下程式碼執行的條件 */

...
}


4.3 尾端註釋


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


以下是一個程式碼中尾端註釋的例子:



if ($a == 2) {

return TRUE; /* 對單一條件的說明 */
} else {
return isPrime($a); /* 其餘的條件 */
}


4.4 行末註釋


註釋界定符"//",可以註釋掉整行或者一行中的一部分。它一般不用於連續多行的註釋文字;然而,它可以用來註釋掉連續多行的程式碼段。以下是所有三種風格的例子:



if ($foo > 1) {


// 第二種用法.

...
}
else {
return false; // 說明返回值的原因
}

//if ($bar > 1) {

//
//  // 第三種用法
//  ...
//}
//else {
// return false;
//}

4.5 文件註釋

文件註釋描述php的類、構造器,方法,以及欄位(field)。每個文件註釋都會被置於註釋定界符/**...*/之中,一個註釋對應一個類或成員。該註釋應位於宣告之前:



/**

* 說明這個類的一些 ...
*/
class Example { ...



注意頂層(top-level)的類是不縮排的,而其成員是縮排的。描述類的文件註釋的第一行(/**)不需縮排;隨後的文件註釋每行都縮排1格(使星號縱向對齊)。成員,包括建構函式在內,其文件註釋的第一行縮排4格,隨後每行都縮排5格。


若你想給出有關類、變數或方法的資訊,而這些資訊又不適合寫在文件中,則可使用實現塊註釋(見5.1.1)或緊跟在聲明後面的單行註釋(見5.1.2)。例如,有關一個類實現的細節,應放入緊跟在類聲明後面的實現塊註釋中,而不是放在文件註釋中。


文件註釋不能放在一個方法或構造器的定義塊中,因為程式會將位於文件註釋之後的第一個宣告與其相關聯。