国产探花免费观看_亚洲丰满少妇自慰呻吟_97日韩有码在线_资源在线日韩欧美_一区二区精品毛片,辰东完美世界有声小说,欢乐颂第一季,yy玄幻小说排行榜完本

首頁 > 開發 > PHP > 正文

淺談PHP 編碼規范-注釋

2024-05-04 21:52:01
字體:
來源:轉載
供稿:網友

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

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

發表評論 共有條評論
用戶名: 密碼:
驗證碼: 匿名發表
主站蜘蛛池模板: 武城县| 土默特左旗| 安陆市| 开远市| 鄱阳县| 定西市| 汕头市| 卢湾区| 申扎县| 元氏县| 阳江市| 杂多县| 上杭县| 瑞金市| 江源县| 淮南市| 香港 | 福泉市| 扶风县| 巩义市| 钟祥市| 青海省| 麟游县| 牙克石市| 庆安县| 南丰县| 普兰县| 镇沅| 黑龙江省| 盐津县| 商洛市| 边坝县| 阜康市| 红河县| 铜鼓县| 陕西省| 图片| 阳泉市| 五莲县| 政和县| 浙江省|