php 注釋 (comments) 有兩種型別:
一種是單行注釋,一種是多行注釋。
php 單行注釋語法
在一行中所有 "//" 符號右面的文字都被視為注釋, 因為 php 解析器忽略該行 "//" 右面的所有內容。 示例如下: 也可以一行只寫注釋,不寫**,如下:
php 多行注釋語法
php 多行注釋以 "/*" 開頭,以 "*/" 結束。在 "/*" 和 "*/" 之間,可以寫多行注釋。 示例如下,紅色部分就是多行注釋的內容。
4.1 塊注釋
塊注釋通常用於提供對檔案,方法,資料結構和演算法的描述。 塊注釋被置於每個檔案的開始處以及每個方法之前;它們也可以被用於其他地方,比如方法內部。 在功能和方法內部的塊注釋應該和它們所描述的**具有一樣的縮排格式。 塊注釋之首應該有乙個空行,用於把塊注釋和**分割開來,比如: /* * 這裡是塊注釋 */ 塊注釋可以以/*-開頭,這樣indent(c語言格式化**)就可以將之識別為乙個**塊的開始,而不會重排它。 /*- * 如果想被忽略,可是使用特別格式的塊注釋 * * one * two * three */ 注意:如果你不使用indent(c語言格式化**),就不必在**中使用/*-,或為他人可能對你的**執行indent(c語言格式化**)作讓步。
4.2 單行注釋
短注釋可以顯示在一行內,並與其後的**具有一樣的縮排層級。 如果乙個注釋不能在一行內寫完,就該採用塊注釋。 單行注釋之前應該有乙個空行。 以下是乙個**中單行注釋的例子: if (condition)
4.3 尾端注釋
極短的注釋可以與它們所要描述的**位於同一行,但是應該有足夠的空白來分開**和注釋。若有多個短注發布現於大段**中,它們應該具有相同的縮排。 以下是乙個**中尾端注釋的例子: if ($a == 2) else
4.4 行末注釋
注釋界定符"//",可以注釋掉整行或者一行中的一部分。 它一般不用於連續多行的注釋文字;然而,它可以用來注釋掉連續多行的**段。 以下是所有三種風格的例子: if ($foo > 1) else //if ($bar > 1) //else
4.5 文件注釋
文件注釋描述php的類、構造器,方法,以及字段(field) 。每個文件注釋都會被置於注釋定界符/**...*/之中,乙個注釋對應乙個類或成員。 該注釋應位於宣告之前: /** * 說明這個類的一些 ... */ class example { ... 注意頂層(top-level)的類是不縮排的,而其成員是縮排的。描述類的文件注釋的第一行(/**)不需縮排;隨後的文件注釋每行都縮排1格(使星號縱向對齊)。成員,包括建構函式在內,其文件注釋的第一行縮排4格,隨後每行都縮排5格。 若你想給出有關類、變數或方法的資訊,而這些資訊又不適合寫在文件中,則可使用實現塊注釋或緊跟在宣告後面的單行注釋。例如,有關乙個類實現的細節,應放入緊跟在類宣告後面的實現塊注釋中,而不是放在文件注釋中。 文件注釋不能放在乙個方法或構造器的定義塊中,因為程式會將位於文件注釋之後的第乙個宣告與其相關聯。
php注釋的基本作用:
1.檔案頭的注釋,介紹檔名,功能以及作者版本號等資訊
/** *檔名簡單介紹 * *檔案功能。 * @author alvin 作者 * @version 1.0 版本號 */
2.函式的注釋,函式作用,引數介紹及返回型別
* 函式的含義說明
* @access public
* @param mixed $arg1 引數一的說明
* @param mixed $arg2 引數二的說明
* @param mixed $mixed 這是乙個混合型別
* @return array 返回型別
3.類的注釋,類名及介紹
* 類的介紹
* 類的詳細介紹(可選。)。
* @author alvin 作者
* @version 1.0 版本號
4.多行注釋
/* php注釋語法
這是多行注釋。*/
5.單行注釋
$n = 10; //數量n,這是單行注釋
php注釋前面 php標準注釋寫法
php標準注釋的寫法 name 名字 abstract 申明變數 類 方法 access 指明這個變數 類 函式 方法的訪問許可權 author 函式作者的名字和郵箱位址 category 組織packages const 指明常量 deprecate 指明不推薦或者是廢棄的資訊 example 示...
php5注釋 php的注釋方法
注釋是每個程式設計師學習時的基礎,我們通過可以注釋來備註一資訊。增加 的可讀性。下面我們就為大家介紹一下php的注釋方法。1,這是單行注釋 2,這也是單行注釋 3,多行注釋塊 這是多行注釋塊 它橫跨了 多行php注釋規範 1 檔案頭的注釋,介紹檔名,功能以及作者版本號等資訊 檔名簡單介紹 檔案功能。...
php注釋前面 PHP注釋種類有哪些
php 注釋 comments 有兩種型別 一種是單行注釋,一種是多行注釋。在一行中所有 符號右面的文字都被視為注釋,因為 php 解析器忽略該行 右面的所有內容。示例如下 也可以一行只寫注釋,不寫 如下 php 多行注釋語法 php 多行注釋以 開頭,以 結束。在 和 之間,可以寫多行注釋。示例如...