php标準的注釋方法

PHP 單行注釋文法

在一行中所有 DE>//DE> 符号右面的文本都被視為注釋， 因為 PHP 解析器忽略該行 DE>//DE> 右面的所有内容。示例如下，紅色字型部分就是單行注釋的内容。

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

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

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

PHP 多行注釋文法

PHP 多行注釋以 DE>DE> 結束。在 DE>DE> 之間，可以寫多行注釋。

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

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

4.1 塊注釋

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

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

塊注釋可以以

注意：如果你不使用indent(1)，就不必在代碼中使用

...

}

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)。例如，有關一個類實作的細節，應放入緊跟在類聲明後面的實作塊注釋中，而不是放在文檔注釋中。

文檔注釋不能放在一個方法或構造器的定義塊中，因為程式會将位于文檔注釋之後的第一個聲明與其相關聯。