什么是php技術(shù)_php系統(tǒng)開(kāi)發(fā)技術(shù)規(guī)范

什么是php技術(shù)

PHP是一種易于學(xué)習(xí)和使用的服務(wù)器端腳本語(yǔ)言。只需要很少的編程知識(shí)你就能使用PHP建立一個(gè)真正交互的WEB站點(diǎn)。 PHP是能讓你生成動(dòng)態(tài)網(wǎng)頁(yè)的工具之一。PHP網(wǎng)頁(yè)文件被當(dāng)作一般HTML網(wǎng)頁(yè)文件來(lái)處理并且在編輯時(shí)你可以用編輯HTML的常規(guī)方法編寫(xiě)PHP。

PHP，一個(gè)嵌套的縮寫(xiě)名稱(chēng)，是英文超級(jí)文本預(yù)處理語(yǔ)言（PHP:Hypertext Preprocessor）的縮寫(xiě)。PHP 是一種HTML內(nèi)嵌式的語(yǔ)言，PHP與微軟的ASP頗有幾分相似，都是一種在服務(wù)器端執(zhí)行的嵌入HTML文檔的腳本語(yǔ)言，語(yǔ)言的風(fēng)格有類(lèi)似于C語(yǔ)言，現(xiàn)在被很多的網(wǎng)站編程人員廣泛的運(yùn)用。PHP 獨(dú)特的語(yǔ)法混合了 C、Java、Perl 以及 PHP 自創(chuàng)新的語(yǔ)法。它可以比 CGI 或者 Perl 更快速的執(zhí)行動(dòng)態(tài)網(wǎng)頁(yè)。用PHP做出的動(dòng)態(tài)頁(yè)面與其他的編程語(yǔ)言相比，PHP是將程序嵌入到HTML文檔中去執(zhí)行，執(zhí)行效率比完全生成HTML標(biāo)記的CGI要高許多；與同樣是嵌入HTML文檔的腳本語(yǔ)言JavaScript相比，PHP在服務(wù)器端執(zhí)行，成分利用了服務(wù)器的性能；PHP執(zhí)行引擎還會(huì)將用戶經(jīng)常訪問(wèn)的PHP程序駐留在內(nèi)存中，其他用戶在一次訪問(wèn)這個(gè)程序時(shí)就不需要重新編譯程序了，只要直接執(zhí)行內(nèi)存中的代碼就可以了，這也是PHP高效率的體現(xiàn)之一。PHP具有非常強(qiáng)大的功能，所有的CGI或者JavaScript的功能PHP都能實(shí)現(xiàn)，而且支持幾乎所有流行的數(shù)據(jù)庫(kù)以及操作系統(tǒng)。

PHP 最初是1994年Rasmus Lerdorf創(chuàng)建的，剛剛開(kāi)始只是一個(gè)簡(jiǎn)單的用Perl語(yǔ)言編寫(xiě)的程序，用來(lái)統(tǒng)計(jì)他自己網(wǎng)站的訪問(wèn)者。后來(lái)又用C語(yǔ)言重新編寫(xiě)，包括可以訪問(wèn)數(shù)據(jù)庫(kù)。在1995年以Personal Home Page Tools （PHP Tools） 開(kāi)始對(duì)外發(fā)表第一個(gè)版本，Lerdorf寫(xiě)了一些介紹此程序的文檔，并且發(fā)布了PHP1.0。在這早期的版本中，提供了訪客留言本、訪客計(jì)數(shù)器等簡(jiǎn)單的功能。以后越來(lái)越多的網(wǎng)站使用了PHP，并且強(qiáng)烈要且增加一些特性，比如循環(huán)語(yǔ)句和數(shù)組變量等等，在新的成員加入開(kāi)發(fā)行列之后，在1995年中，PHP2.0發(fā)布了。第二版定名為PHP/FI（Form Interpreter）。PHP/FI加入了對(duì)mSQL的支持，從此建立了PHP在動(dòng)態(tài)網(wǎng)頁(yè)開(kāi)發(fā)上的地位。到了1996年底，有15000個(gè)網(wǎng)站使用 PHP/FI；時(shí)間到了1997年中，使用PHP/FI的網(wǎng)站數(shù)字超過(guò)五萬(wàn)個(gè)。而在1997年中，開(kāi)始了第三版的開(kāi)發(fā)計(jì)劃，開(kāi)發(fā)小組加入了 Zeev Suraski 及 Andi Gutmans，而第三版就定名為PHP3。2000年，PHP4.0又問(wèn)世了，其中增加了許多新的特性。

php系統(tǒng)開(kāi)發(fā)技術(shù)規(guī)范

1 編寫(xiě)目的

為了更好的提高技術(shù)部的工作效率，保證開(kāi)發(fā)的有效性和合理性，并可最大程度的提高程序代碼的可讀性和可重復(fù)利用性，指定此規(guī)范。開(kāi)發(fā)團(tuán)隊(duì)根據(jù)自己的實(shí)際情況，可以對(duì)本規(guī)范進(jìn)行補(bǔ)充或裁減。

2 整體要求

技術(shù)部php開(kāi)發(fā)規(guī)范將參照PEAR的規(guī)范，基本采用PEAR指定的規(guī)范，在其基礎(chǔ)上增加、修改或刪除部分適合具體開(kāi)發(fā)環(huán)境的規(guī)范。本規(guī)范只針對(duì)PHP開(kāi)發(fā)過(guò)程中編碼的規(guī)范，對(duì)于PHP開(kāi)發(fā)項(xiàng)目中文件、目錄、數(shù)據(jù)庫(kù)等方面的規(guī)范，將不重點(diǎn)涉及。

本規(guī)范包含了PHP開(kāi)發(fā)時(shí)程序編碼中命名規(guī)范、代碼縮進(jìn)規(guī)則、控制結(jié)構(gòu)、函數(shù)調(diào)用、函數(shù)定義、注釋、包含代碼、PHP標(biāo)記、文件頭的注釋塊、CVS標(biāo)記、URL樣例、常量命名等方面的規(guī)則。

3 安全規(guī)范

3.1 包含文件

3.1.1 命名規(guī)則

提取出來(lái)具有通用函數(shù)的包含文件，文件后綴以.inc來(lái)命名，表明這是一個(gè)包含文件。

如果有多個(gè).inc文件需要包含多頁(yè)面，請(qǐng)把所有.inc文件封裝在一個(gè)文件里面，具體到頁(yè)面只需要包換一個(gè).inc文件就可以了

如：xxx_session.inc

xxx_comm..inc

xxx_setting.inc

mysql_db.inc

把以上文件以一下方式，封裝在xxx.basic.inc文件里面

require_once（”xxx_session.inc”）;

require_once（”xxx_comm.inc”）;

require_once（”xxx_setting.inc”）;

require_once（”mysql_db.inc”）;

注：是否需要封裝到一個(gè)文件，視情況而定，如果每個(gè)inc的功能是分散到不同的頁(yè)面使用的話，就不建議封裝。

3.1.2 存放規(guī)則

一般包含文件不需要直接暴露給用戶，所以應(yīng)該放在 Web Server訪問(wèn)不到的目錄，避免因?yàn)榕渲脝?wèn)題而泄露設(shè)置信息。

3.2 安全規(guī)則

請(qǐng)參考產(chǎn)品安全檢查表。

輸入和輸出

檢查是否做了HTML代碼的過(guò)濾

可能出現(xiàn)的問(wèn)題：如果有人輸入惡意的HTML代碼，會(huì)導(dǎo)致竊取cookie， 產(chǎn)生惡意登錄表單，和破壞網(wǎng)站

檢查變量做數(shù)據(jù)庫(kù)操作之前是否做了escape

可能出現(xiàn)的問(wèn)題：如果一個(gè)要寫(xiě)入查詢語(yǔ)句的字符串變量包含了某些特殊的字符，比如引號(hào)（’ ，”）或者分號(hào)（;） 可能造成執(zhí)行了預(yù)期之外的操作。

建議采用的方法：使用mysql_escape_string（） 或?qū)崿F(xiàn)類(lèi)似功能的函數(shù)。

檢查輸入數(shù)值的合法性

可能出現(xiàn)的問(wèn)題：異常的數(shù)值會(huì)造成問(wèn)題。如果對(duì)輸入的數(shù)值不做檢查會(huì)造成不合法的或者錯(cuò)誤的數(shù)據(jù)存入U(xiǎn)DB、存入其它的數(shù)據(jù)庫(kù)或者導(dǎo)致意料之外的程序操作發(fā)生。

舉例：

如果程序以用戶輸入的參數(shù)值做為文件名，進(jìn)行文件操作，惡意輸入系統(tǒng)文件名會(huì)造成系統(tǒng)損毀。

核實(shí)對(duì)cookie的使用以及對(duì)用戶數(shù)據(jù)的處理

可能出現(xiàn)的問(wèn)題：不正確的cookie使用可能造成用戶數(shù)據(jù)泄漏

訪問(wèn)控制

對(duì)內(nèi)部使用的產(chǎn)品或者供合作方使用的產(chǎn)品，要考慮增加訪問(wèn)控制

logs

確保用戶的保密信息沒(méi)有記在log中（例如：用戶的密碼）

確保對(duì)關(guān)鍵的用戶操作保存了完整的用戶訪問(wèn)記錄

https

對(duì)敏感數(shù)據(jù)的傳輸要采用https

3.3 一些針對(duì)PHP的規(guī)則

設(shè)置 register_globals = off （Y！PHP 已經(jīng)禁止了register_globals，如果你使用Y！PHP可以不考慮這項(xiàng)設(shè)置）

設(shè)置 error_reporting = E_ALL （Y！PHP 的缺省設(shè)置），并且要修正所有的error和warning

將實(shí)際的操作放在被引用的文件中。把引用文件放到不可以被直接瀏覽的目錄下

3.4 其它處理規(guī)則

3.4.1 對(duì)輸入?yún)?shù)值進(jìn)行轉(zhuǎn)義處理

頁(yè)面接到參數(shù)需要SQL操作，這時(shí)候需要做轉(zhuǎn)義，尤其需要注意”;”。

如：$a = ” Let’s go ” ;

$sql = “Insert into tmp（col） values（’$a’）” ;

這種情況出現(xiàn)錯(cuò)誤的不確定性。

3.4.2 操作大HTML文本

很多時(shí)候需要存放一大段HTML文本供頁(yè)面使用，象用戶定制頁(yè)頭頁(yè)腳等。

需要剔除腳本標(biāo)記，避免執(zhí)行惡意php代碼。

轉(zhuǎn)換”《“”》“號(hào)，保證代碼完整。

4 編碼規(guī)范

4.1 命名規(guī)范

制定統(tǒng)一的命名規(guī)范對(duì)于項(xiàng)目開(kāi)發(fā)來(lái)說(shuō)非常重要，不但可以養(yǎng)成程序員一個(gè)良好的開(kāi)發(fā)習(xí)慣，還能增加程序的可讀性、可移植性和可重用性，還能很好的提高項(xiàng)目開(kāi)發(fā)的效率。

4.1.1 變量命名

變量命名分為普通變量、靜態(tài)變量、局部變量、全局變量、Session變量等方面的命名規(guī)則。

4.1.1.1 普通變量

普通變量命名遵循以下規(guī)則：

a． 所有字母都使用小寫(xiě)；

b． 對(duì)于一個(gè)變量使用多個(gè)單詞的，使用’_‘作為每個(gè)詞的間隔。

例如：$base_dir、$red_rose_price等

4.1.1.2 靜態(tài)變量

靜態(tài)變量命名遵循以下規(guī)則：

a． 靜態(tài)變量使用小寫(xiě)的s_開(kāi)頭；

b． 靜態(tài)變量所有字母都使用小寫(xiě)；

c． 多個(gè)單詞組成的變量名使用’_’作為每個(gè)詞的間隔。

例子：$s_base_dir、$s_red_rose_prise等。

4.1.1.3 局部變量

局部變量命名遵循以下規(guī)則：

a． 所有字母使用小寫(xiě)；

b． 變量使用’_‘開(kāi)頭；

c． 多個(gè)單詞組成的局部變量名使用’_’作為每個(gè)詞間的間隔。

例子：$_base_dir、$_red_rose_price等。

4.1.1.4 全局變量

全局變量應(yīng)該帶前綴’g‘，知道一個(gè)變量的作用域是非常重要的。

例如

global $gLOG_LEVEL;

global $gLOG_PATH;

4.1.1.5 全局常量

全局變量命名遵循以下規(guī)則：

a． 所有字母使用大寫(xiě)

b． 全局變量多個(gè)單詞間使用’_’作為間隔。

例子：$BASE_DIR、$RED_ROSE_PRICE等。

4.1.1.6 session變量

session變量命名遵循以下規(guī)則：

a． 所有字母使用大寫(xiě)；

b． session變量名使用’S_’開(kāi)頭；

c． 多個(gè)單詞間使用’_‘間隔。

例子：$S_BASE_DIR、$S_RED_ROSE_PRICE等。

4.1.2 類(lèi)

php中類(lèi)命名遵循以下規(guī)則：

a． 以大寫(xiě)字母開(kāi)頭；

b． 多個(gè)單詞組成的變量名，單詞之間不用間隔，各個(gè)單詞首字母大寫(xiě)。

例子：class MyClass 或class DbOracle等。

4.1.3 方法或函數(shù)

方法或函數(shù)命名遵循以下規(guī)則：

a． 首字母小寫(xiě)；

b． 多個(gè)單詞間不使用間隔，除第一個(gè)單詞外，其他單詞首字母大寫(xiě)。

例子：function myFunction （）或function myDbOracle （）等。

4.1.4 縮寫(xiě)詞

當(dāng)變量名或者其他命名中遇到縮寫(xiě)詞時(shí)，參照具體的命名規(guī)則，而不采用縮寫(xiě)詞原來(lái)的全部大寫(xiě)的方式。

例子：function myPear（不是myPEAR） functio getHtmlSource（不是getHTMLSource）。

4.1.5 數(shù)據(jù)庫(kù)表名

數(shù)據(jù)庫(kù)表名命名遵循以下規(guī)范：

a． 表名均使用小寫(xiě)字母；

b． 對(duì)于普通數(shù)據(jù)表，使用_t結(jié)尾；

c． 對(duì)于視圖，使用_v結(jié)尾；

d． 對(duì)于多個(gè)單詞組成的表名，使用_間隔；

例子：user_info_t和book_store_v等

4.1.6 數(shù)據(jù)庫(kù)字段

數(shù)據(jù)庫(kù)字段命名遵循以下規(guī)范：

a． 全部使用小寫(xiě)；

b． 多個(gè)單詞間使用_間隔。

例子：user_name、rose_price等。

4.2 書(shū)寫(xiě)規(guī)則

書(shū)寫(xiě)規(guī)則是指在編寫(xiě)php程序時(shí)，代碼書(shū)寫(xiě)的規(guī)則，包括縮進(jìn)、結(jié)構(gòu)控制等方面規(guī)范：

4.2.1 代碼縮進(jìn)

在書(shū)寫(xiě)代碼的時(shí)候，必須注意代碼的縮進(jìn)規(guī)則，我們規(guī)定代碼縮進(jìn)規(guī)則如下：

a． 使用4個(gè)空格作為縮進(jìn)，而不使用tab縮進(jìn)（對(duì)于ultraedit，可以進(jìn)行預(yù)先設(shè)置）

例子：

for （ $i=0;$i《$count;$i++ ）

{

echo “test”;

}

4.2.2 大括號(hào){ }書(shū)寫(xiě)規(guī)則

在程序中進(jìn)行結(jié)構(gòu)控制代碼編寫(xiě)，如if、for、while、switch等結(jié)構(gòu)，大括號(hào)傳統(tǒng)的有兩種書(shū)寫(xiě)習(xí)慣，分別如下：

a．{直接跟在控制語(yǔ)句之后，不換行，如

for （$i=0;$i《$count;$i++） {

echo “test”;

}

b．{在控制語(yǔ)句下一行，如

for（$i=0;$i《$count;$i++）

{

echo “test”;

}

其中，a是PEAR建議的方式，但是從實(shí)際書(shū)寫(xiě)中來(lái)講，這并不影響程序的規(guī)范和影響用phpdoc實(shí)現(xiàn)文檔，所以可以根據(jù)個(gè)人習(xí)慣來(lái)采用上面的兩種方式，但是要求在同一個(gè)程序中，只使用其中一種，以免造成閱讀的不方便。

4.2.3 小括號(hào)（ ）和函數(shù)、關(guān)鍵詞等

小括號(hào)、關(guān)鍵詞和函數(shù)遵循以下規(guī)則：

a． 不要把小括號(hào)和關(guān)鍵詞緊貼在一起，要用一個(gè)空格間隔；如if （ $a《$b ）；

b． 小括號(hào)和函數(shù)名間沒(méi)有空格；如$test = date（“ymdhis”）；

c． 除非必要，不要在Return返回語(yǔ)句中使用小括號(hào)。 如Return $a；

4.2.4 ＝符號(hào)書(shū)寫(xiě)

在程序中=符號(hào)的書(shū)寫(xiě)遵循以下規(guī)則：

a． 在=符號(hào)的兩側(cè)，均需留出一個(gè)空格；如$a = $b 、if （$a = = $b）等；

b． 在一個(gè)申明塊，或者實(shí)現(xiàn)同樣功能的一個(gè)塊中，要求=號(hào)盡量上下對(duì)其，左邊可以為了保持對(duì)齊使用多個(gè)空格，而右邊要求空一個(gè)空格；如下例：

$testa = $aaa;

$testaa = $bbb;

$testaaa = $ccc;

4.2.5 if else swith for while等書(shū)寫(xiě)

對(duì)于控制結(jié)構(gòu)的書(shū)寫(xiě)遵循以下規(guī)則：

a． 在if條件判斷中，如果用到常量判斷條件，將常量放在等號(hào)或不等號(hào)的左邊，例如：

if （ 6 == $errorNum ），因?yàn)槿绻阍诘仁街新┝艘粋€(gè)等號(hào)，語(yǔ)法檢查器會(huì)為你報(bào)錯(cuò)，可以很快找到錯(cuò)誤位置，這樣的寫(xiě)法要多注意；

b． switch結(jié)構(gòu)中必須要有default塊；

c． 在for和wiile的循環(huán)使用中，要警惕continue、break的使用，避免產(chǎn)生類(lèi)似goto的問(wèn)題；

4.2.6 類(lèi)的構(gòu)造函數(shù)

如果要在類(lèi)里面編寫(xiě)構(gòu)造函數(shù)，必須遵循以下規(guī)則：

a． 不能在構(gòu)造函數(shù)中有太多實(shí)際操作，頂多用來(lái)初始化一些值和變量；

b． 不能在構(gòu)造函數(shù)中因?yàn)槭褂貌僮鞫祷豧alse或者錯(cuò)誤，因?yàn)樵诼暶骱蛯?shí)例化一個(gè)對(duì)象的時(shí)候，是不能返回錯(cuò)誤的；

4.2.7 語(yǔ)句斷行， 每行控制在80個(gè)字符以內(nèi)

在代碼書(shū)寫(xiě)中，遵循以下原則：

a． 盡量保證程序語(yǔ)句一行就是一句，而不要讓一行語(yǔ)句太長(zhǎng)產(chǎn)生折行；

b． 盡量不要使一行的代碼太長(zhǎng)，一般控制在80個(gè)字符以內(nèi)；

c． 如果一行代碼太長(zhǎng)，請(qǐng)使用類(lèi)似 。= 的方式斷行書(shū)寫(xiě)；

d． 對(duì)于執(zhí)行數(shù)據(jù)庫(kù)的sql語(yǔ)句操作，盡量不要在函數(shù)內(nèi)寫(xiě)sql語(yǔ)句，而先用變量定義sql語(yǔ)句，然后在執(zhí)行操作的函數(shù)中調(diào)用定義的變量；

例子：

$sql = “SELECT username，password，address，age，postcode FROM test_t ”;

$sql 。= “ WHERE username=’aaa‘”;

$res = mysql_query（$sql）;

4.2.8 不要不可思議的數(shù)字

一個(gè)在源代碼中使用了的赤裸裸的數(shù)字是不可思議的數(shù)字，因?yàn)榘ㄗ髡撸谌齻€(gè)月內(nèi)，沒(méi)人它的含義。例如：

if （22 == $foo）

{

start_thermo_nuclear_war（）;

}

else if （19 == $foo）

{

refund_lotso_money（）;

}

else

{

cry_cause_im_lost（）;

}

你應(yīng)該用define（）來(lái)給你想表示某樣?xùn)|西的數(shù)值一個(gè)真正的名字，而不是采用赤裸裸的數(shù)字，例如：

define（“PRESIDENT_WENT_CRAZY”， “22”）;

define（“WE_GOOFED”， “19”）;

define（“THEY_DIDNT_PAY”， “16”）;

if （ PRESIDENT_WENT_CRAZY == $foo）

{

start_thermo_nuclear_war（）;

}

else if （WE_GOOFED == $foo）

{

refund_lotso_money（）;

}

else if （THEY_DIDNT_PAY == $foo）

{

infinite_loop（）;

}

else

{

happy_days_i_know_why_im_here（）;

}

4.2.9 true/false和0/1判斷

遵循以下規(guī)則：

a． 不能使用0/1代替true/false，在PHP中，這是不相等的；

b． 不要使用非零的表達(dá)式、變量或者方法直接進(jìn)行true/false判斷，而必須使用嚴(yán)格的完整true/false判斷；

如：不使用if （$a） 或者if （checka（）） 而使用if （FALSE ！= $a）或者 if （FALSE ！= check（））

4.2.10 避免嵌入式賦值

在程序中避免下面例子中的嵌入式賦值：

不使用這樣的方式：

while （$a ！= （$c = getchar（）））

{

process the character

}

4.2.11 錯(cuò)誤返回檢測(cè)規(guī)則

檢查所有的系統(tǒng)調(diào)用的錯(cuò)誤信息，除非你要忽略錯(cuò)誤。

為每條系統(tǒng)錯(cuò)誤消息定義好系統(tǒng)錯(cuò)誤文本，并記錄錯(cuò)誤LOG。

4.3 程序注釋

每個(gè)程序均必須提供必要的注釋?zhuān)瑫?shū)寫(xiě)注釋要求規(guī)范，參照PEAR提供的注釋要求，為今后利用phpdoc生成php文檔做準(zhǔn)備。程序注釋的原則如下：

a． 注釋中除了文件頭的注釋塊外，其他地方都不使用//注釋?zhuān)褂?* */的注釋?zhuān)?/p>

b． 注釋內(nèi)容必須寫(xiě)在被注釋對(duì)象的前面，不寫(xiě)在一行或者后面；

4.3.1 程序頭注釋塊

每個(gè)程序頭部必須有統(tǒng)一的注釋塊，規(guī)則如下：

a． 必須包含本程序的描述；

b． 必須包含作者；

c． 必須包含書(shū)寫(xiě)日期；

d． 必須包含版本信息；

e． 必須包含項(xiàng)目名稱(chēng)；

f． 必須包含文件的名稱(chēng)；

g． 重要的使用說(shuō)明，如類(lèi)的調(diào)用方法、注意事項(xiàng)等；

參考例子如下：

《？php

//

// +---------------------------------------------------------+

// | PHP version 4.0 |

// +---------------------------------------------------------+

// | Copyright （c） 1997-2001 The PHP Group |

// +---------------------------------------------------------+

// | This source file is subject to of the PHP license， |

// | that is bundled with this packafile LICENSE， and is |

// | available at through the world-web at |

// | http://www.php.net/license/2_02.txt. |

// | If you did not receive a copy of the and are unable to |

// | obtain it through the world-wide-web，end a note to |

// | license@php.net so we can mail you a immediately. |

// +---------------------------------------------------------+

// | Authors： Stig Bakken 《ssb@fast.no》 |

// | Tomas V.V.Cox 《cox@idecnet.com》 |

// | |

// +---------------------------------------------------------+

//

// $Id： Common.php，v 1.8.2.3 2001/11/13 01:26:48 ssb Exp $

4.3.2 類(lèi)的注釋

類(lèi)的注釋采用里面的參考例子方式：

/**

* @ Purpose：

* 訪問(wèn)數(shù)據(jù)庫(kù)的類(lèi)，以O(shè)DBC作為通用訪問(wèn)接口

* @Package Name： Database

* @Author： Forrest Gump gump@crtvu.edu.cn

* @Modifications：

* No20020523-100：

* odbc_fetch_into（）參數(shù)位置第二和第三個(gè)位置調(diào)換

* John Johnson John@crtvu.edu.cn

* @See： （參照）

*/

class Database

{

……

}

4.3.3 函數(shù)和方法的注釋

函數(shù)和方法的注釋寫(xiě)在函數(shù)和方法的前面，采用類(lèi)似下面例子的規(guī)則：

/**

* @Purpose：

* 執(zhí)行一次查詢

* @Method Name： Query（）

*

* @Param： string $queryStr SQL查詢字符串

* @Param： string $username 用戶名

*

* @Author： Michael Lee

*

* @Return： mixed 查詢返回值（結(jié)果集對(duì)象）

*/

function（$queryStr，$username）

{……}

4.3.4 變量或者語(yǔ)句注釋

程序中變量或者語(yǔ)句的注釋遵循以下原則：

a． 寫(xiě)在變量或者語(yǔ)句的前面一行，而不寫(xiě)在同行或者后面；

b． 注釋采用/* */的方式；

c． 每個(gè)函數(shù)前面要包含一個(gè)注釋塊。內(nèi)容包括函數(shù)功能簡(jiǎn)述，輸入/輸出參數(shù)，預(yù)期的返回值，出錯(cuò)代碼定義。

d． 注釋完整規(guī)范。

e． 把已經(jīng)注釋掉的代碼刪除，或者注明這些已經(jīng)注釋掉的代碼仍然保留在源碼中的特殊原因。

f．

例子：

/**

* @Purpose：

* 數(shù)據(jù)庫(kù)連接用戶名

* @Attribute/Variable Name： db_user_name

* @Type： string

*/

var db_user_name;

4.4 其他規(guī)范（建議）

4.4.1 php代碼標(biāo)記

所有的php程序代碼塊標(biāo)記均使用

4.4.2 程序文件名、目錄名

程序文件名和目錄名命名均采用有意義的英文方式命名，不使用拼音或無(wú)意義的字母，同時(shí)均必須使用小寫(xiě)字母，多個(gè)詞間使用_間隔。

4.4.3 PHP項(xiàng)目通常的文件目錄結(jié)構(gòu)

建議在開(kāi)發(fā)規(guī)范的獨(dú)立的PHP項(xiàng)目時(shí)，使用規(guī)范的文件目錄結(jié)構(gòu)，這有助于提高項(xiàng)目的邏輯結(jié)構(gòu)合理性，對(duì)應(yīng)擴(kuò)展和合作，以及團(tuán)隊(duì)開(kāi)發(fā)均有好處。

一個(gè)完整獨(dú)立的PHP項(xiàng)目通常的文件和目錄結(jié)構(gòu)如下：

/ 項(xiàng)目根目錄

/manage 后臺(tái)管理文件存放目錄

/css css文件存放目錄

/doc 存放項(xiàng)目文檔

/images 所有圖片文件存放路徑（在里面根據(jù)目錄結(jié)構(gòu)設(shè)立子目錄）

/scripts 客戶端js腳本存放目錄

/tpl 網(wǎng)站所有html的模版文件存放目錄

/error.php 錯(cuò)誤處理文件（可以定義到apache的錯(cuò)誤處理中）

以上目錄結(jié)構(gòu)是通常的目錄結(jié)構(gòu)，根據(jù)具體應(yīng)用的具體情況，可以考慮不用完全遵循，但是盡量做到規(guī)范化。

4.4.4 PHP和HTML代碼的分離問(wèn)題

對(duì)性能要求不是很高的項(xiàng)目和應(yīng)用，我們建議不采用PHP和HTML代碼直接混排的方式書(shū)寫(xiě)代碼，而采用PHP和HTML代碼分離的方式，即采用模版的方式處理，這樣一方面對(duì)程序邏輯結(jié)構(gòu)更加清晰有利，也有助于開(kāi)發(fā)過(guò)程中人員的分工安排，同時(shí)還對(duì)日后項(xiàng)目的頁(yè)面升級(jí)該版提供更多便利。

對(duì)于一些特殊情況，比如對(duì)性能要求很高的應(yīng)用，可以不采用模版方式。

4.4.5 PHP項(xiàng)目開(kāi)發(fā)中的程序邏輯結(jié)構(gòu)

對(duì)于PHP項(xiàng)目開(kāi)發(fā)，盡量采用OOP的思想開(kāi)發(fā)，尤其在PHP5以后，對(duì)于面向?qū)ο蟮拈_(kāi)發(fā)功能大大提高。

在PHP項(xiàng)目中，我們建議將獨(dú)立的功能模塊盡量寫(xiě)成函數(shù)調(diào)用，對(duì)應(yīng)一整塊業(yè)務(wù)邏輯，我們建議封裝成類(lèi)，既可以提高代碼可讀性，也可以提高代碼重用性。比如，我們通常將對(duì)數(shù)據(jù)庫(kù)的接口封裝成數(shù)據(jù)庫(kù)類(lèi)，有利于平臺(tái)的移植。

重復(fù)的代碼要做成公共的庫(kù)。（除了我們?cè)趐lug-in產(chǎn)品上遇到的情況，該產(chǎn)品系列有多個(gè)相類(lèi)似的產(chǎn)品，為了盡可能地減少安裝包尺寸，不適合將這些產(chǎn)品共用的所有函數(shù)做成公共的庫(kù)）

5 特定環(huán)境下PHP編碼特殊規(guī)范

5.1 變量定義

XXX環(huán)境下的php代碼編寫(xiě)要求所有的變量均需要先申明后使用，否則會(huì)有錯(cuò)誤信息，對(duì)于數(shù)組，在使用一個(gè)不確定的key時(shí)，比如先進(jìn)行isset（）的判斷，然后再使用；比如下面的代碼：

$array ＝ array（）;

$var ＝ isset（$array［3］） ？ $array［3］ ： “”；

5.2 引用的使用

引用在程序中使用比較多，為了公用同一個(gè)內(nèi)存，而不需要另外進(jìn)行復(fù)制，XXX環(huán)境下的引用使用時(shí)，需要注意下面的情況；

在對(duì)函數(shù)的輸入?yún)?shù)中使用引用時(shí)，不能在調(diào)用的時(shí)候在輸入?yún)?shù)前加&來(lái)引用，而直接使用該變量即可，同時(shí)必須在函數(shù)定義的時(shí)候說(shuō)明輸入?yún)?shù)來(lái)自引用，比如下面的代碼：

$a ＝ 1；

function ab（&$var）

{

$var ++；

return $var；

}

$b ＝ ab（$a） // 注意，此處不能使用 $b ＝ ab（&$a）的方式；

echo $b.”/n”；

echo $a.”/n”；

此時(shí) $a和$b都是2；

XXX環(huán)境下對(duì)引用的特殊要求源自php.ini文件里面的allow_call_time_pass_reference 項(xiàng)設(shè)置， 對(duì)外公開(kāi)的版本是 On ，這樣就可以支持&直接加到調(diào)用函數(shù)時(shí)變量前面進(jìn)行引用，但是這一方法遭到抗議，并可能在將來(lái)版本的PHP/Zend里不再支持。受到鼓勵(lì)的指定哪些參數(shù)按引用傳遞的方法是在函數(shù)聲明里。你被鼓勵(lì)嘗試關(guān)閉這一選項(xiàng)（使用 off，XXX的所有運(yùn)行環(huán)境下都是off）并確認(rèn)你的腳本仍能正常工作，以保證在將來(lái)版本的語(yǔ)言里它們?nèi)阅芄ぷ鳌?/p>

5.3 變量的輸入輸出

在XXX環(huán)境下，對(duì)web通過(guò)GET或者POST方法傳遞來(lái)的參數(shù)均要求進(jìn)行嚴(yán)格的過(guò)濾和合法性驗(yàn)證，不推薦使用直接的$_GET、$_POST或者$_REQUEST獲取，而通過(guò)XXX的XXX_yiv模塊提供的方法獲取和過(guò)濾處理