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

首頁 > 編程 > PHP > 正文

PHP編程風格規范分享

2020-03-22 19:50:22
字體:
來源:轉載
供稿:網友
說明:本規范由 EasyChen 借鑒 SINA網絡應用開發部《C++開發規范》和互動技術部《PHP4開發規范》,以及phpDocument規范 整理出的開發規范。我覺得非常不錯, 適合PHP的開發,給大家參考,養成一個良好的編程風格是非常有必要的。第1章 命名規范1.1變量1.1.1html' target='_blank'>全局變量全局變量使用$g_開頭,如$g_data_list。1.1.2 一般變量一般的變量使用小寫字母命名,單詞之間使用下劃線分隔。變量名字應該使用名詞或者形容詞+名詞的方式。如$value,$new_value。1.1.3 臨時變量不要將在循環中頻繁使用的臨時變量如$i、$j等用于其它用途。1.2 函數函數采用小寫字母命名,單詞之間使用下劃線分隔。函數的命名建議使用動詞+名詞的方式,如get_user_img。完成一組功能的函數放到一個文件中,存放函數的文件采用function_name.func.php命名。1.3 類類使用英文的大小寫來分隔單詞,包括首個單詞,所有單詞的首字母大寫,如PageManager;在類中,方法放到屬性定義前邊、公用方法放到專用方法前邊;一般情況下,一個類對應到一個文件;當一些類關系緊密時,可以存放在一個文件中;存放類的文件采用ClassName.class.php方式命名。1.4 方法方法使用英文的大小寫來分隔單詞,除首個單詞外,其他單詞的首字母大寫,如getCurrentPage();不要采用不常用的縮寫,如where2go();使用常用的縮寫時,只大寫首字母,如getHtml()。第2章 版式規則2.1 語義分隔各個函數、方法之間應該采用空行間隔;同一個函數中聯系緊密的語句之間可以不換行,其他情況需要換行。2.2 空格規則2.2.1 邏輯運算符前后必須加空格

正確復制代碼 代碼如下:$a == $b; 錯誤復制代碼 代碼如下:
$a==$b;
$a ==$b;
正確復制代碼 代碼如下:$a++; $a--; 錯誤復制代碼 代碼如下:$a ++; $a --; 備注 加一減一運算符不能加空格。2.2.2 多個參數分隔時必須加空格
正確復制代碼 代碼如下:
$g_pro , $g_user , g_show;
get_db_info($host, $user, $passwd);
錯誤復制代碼 代碼如下:
$g_pro,$g_user,$g_show;
get_db_info($host,$user,$passwd);
2.2.3 語法關鍵字后必須加空格例如:If, for , while, switch …..
正確復制代碼 代碼如下:for ($i = 0; $i $i++) 錯誤復制代碼 代碼如下:for($i = 0; $i $i++ ) 2.3 字符串和變量連接規則
字符串與變量連接使用'.'號時,必須在'.'前后加空格,使用"號時,必須在變量前后加"{}"。
正確復制代碼 代碼如下:
$my_name = 'file_' . $var1;
$my_name = "file_{$var1}";
錯誤復制代碼 代碼如下:
$my_name = "file_'.$var1;
$my_name = "file_$var1";
2.4 圓括號規則
函數名后括號不需要加空格、語法關鍵字后的括號必須加空格。
正確復制代碼 代碼如下:for ($i = 0; $i $i++)
strlen($my_name);
錯誤復制代碼 代碼如下:for($i = 0; $i $i++ )
strlen ($my_name);
2.5 花括號規則
花括號必須為上下對應。正確復制代碼 代碼如下:
if ($a)
{
$b = $a;
}
錯誤復制代碼 代碼如下:
if ($a){
$b = $a;
}
2.6 數組定義規則數組定義和使用時中key值前后必須加單引號。
PHP 代碼:
正確復制代碼 代碼如下:
array( 'name' = '', 'gender' = '' );
$user_info['name'];
錯誤復制代碼 代碼如下:
array( name = '', gender = '' );
$user_info[name];
2.7 SQL規則

在PHP中嵌入的SQL語句關鍵字全部采用大寫;
表名和字段名要用反引號(`)引起來以防止因為字段名中包含空格而出現錯誤;
數據值兩邊用單引號''包括,并且應確保數據值中的單引號已經轉義以防止SQL注入。

正確復制代碼 代碼如下:$sql = "SELECT `user`.`name` FROM `user` WHERE `id` = '$id' LIMIT 1"; 錯誤復制代碼 代碼如下:$sql = "select name.user from name where id = $id "; 第3章 注釋規則

3.1 一般規則
不寫不必要的注釋;只有當代碼不能很好地說明邏輯時,才用注釋補充;
把注釋看成程序的一部分,在編寫/維護代碼時同時編寫/維護注釋;
注釋完全采用PHPDocumentor的規范,以方便用其生成API級文檔。

3.2 詳細規則
請參見PHPDocumentor手冊。下邊給出各個部分的注釋示范。

3.2.1 版權信息
注釋名稱 版權信息
注釋示范:復制代碼 代碼如下:
//
// +----------------------------------------------------+
// | phpDocumentor |
// +----------------------------------------------------+
// | Copyright (c) 2000-2003 Joshua Eichorn |
// | Email jeichorn@phpdoc.org |
// | Web http://www.phpdoc.org |
// +----------------------------------------------------+
// | This source file is subject to PHP License |
// +----------------------------------------------------+
//
備注 使用//來標示版權信息,以免和PHPDocumentor的page-level DocBlock發生沖突

3.2.2文件頭注釋示例

注釋名稱 文件頭注釋
注釋示范:PHP 代碼:復制代碼 代碼如下:
/**
* All abstract representations of inline tags are in this file
* @package phpDocumentor
* @subpackage InlineTags
* @since separate file since version 1.2
* @version $Id $
*/
備注
1)文件頭注釋需要指明所屬的包和子包;
2)在@version中加上$ID,以方便使用CVS管理文件。

3.2.3 類注釋示例
注釋名稱 類注釋
注釋示范: PHP 代碼:復制代碼 代碼如下:
/**
* Use this element to represent an {@}inline tag} like {@}link}
* @see parserStringWithInlineTags
* @package phpDocumentor
* @subpackage InlineTags
* @author Greg Beaver cellog@users.sourceforge.net
* @since 1.0rc1
* @version $Revision: 1.21.2.6 $
* @tutorial inlinetags.pkg
*/


3.2.4 類屬性注釋示例
注釋名稱 類屬性注釋
注釋示范:
PHP 代碼:復制代碼 代碼如下:
/**
* Element type
*
* Type is used by many functions to skip the hassle of
*
* code
* if get_class($blah) == 'parserBlah'
* /code
* always "inlinetag"
* @var string
*/
var $type = 'inlinetag';
3.2.5 函數/類方法注釋示例
注釋名稱 函數/類方法注釋
注釋示范:
PHP 代碼:復制代碼 代碼如下:
/**
* @return string always ''
* calculate the short description of a DocBlock
* @see parserStringWithInlineTags::getString()
* @see parserStringWithInlineTags::trimmedStrlen()
*/
function getString()
{
return '';
}
PHP教程

鄭重聲明:本文版權歸原作者所有,轉載文章僅為傳播更多信息之目的,如作者信息標記有誤,請第一時間聯系我們修改或刪除,多謝。

發表評論 共有條評論
用戶名: 密碼:
驗證碼: 匿名發表
主站蜘蛛池模板: 谷城县| 苍梧县| 民县| 岱山县| 铜鼓县| 沙河市| 河间市| 灌阳县| 博野县| 鹤峰县| 潢川县| 旅游| 黑水县| 桐梓县| 郎溪县| 仙居县| 冕宁县| 西青区| 景洪市| 正蓝旗| 全州县| 安义县| 库伦旗| 锡林浩特市| 监利县| 股票| 乳源| 浪卡子县| 聂拉木县| 海阳市| 湖州市| 专栏| 徐水县| 江城| 深水埗区| 青川县| 皮山县| 民县| 台前县| 德令哈市| 锡林浩特市|