- 相關推薦
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)。例如，有關一個類實現的細節，應放入緊跟在類聲明后面的實現塊注釋中，而不是放在文檔注釋中。
【php中的注釋包括哪些】相關文章：
php正則去掉php注釋07-30
PHP 7.1 中的重大更新有哪些11-08
php中的有關錯誤的配置有哪些10-25
PHP 7.1中有哪些重大的更新07-27
在PHP中操作MySQL要注意哪些問題07-18
PHP 7.1中都有哪些重大更新10-01
PHP語法解析：開頭、注釋、變量11-12
PHP文件注釋標記及規范小結08-09