|
作為php開發(fā)規(guī)范的開篇,我從一個(gè)純php開發(fā)者的角度來說說我所認(rèn)為的php代碼規(guī)范,主要從php目錄框架結(jié)構(gòu)、php代碼書寫規(guī)范、php文件命名規(guī)范三個(gè)角度來闡述,希望對php入門學(xué)習(xí)者有所幫助。
合理建設(shè)php目錄框架結(jié)構(gòu)
我們知道在使用php進(jìn)行網(wǎng)站開發(fā)之前,我們需要建設(shè)網(wǎng)站的目錄結(jié)構(gòu),網(wǎng)站目錄框架結(jié)構(gòu)設(shè)計(jì)得合理規(guī)范,不但有利于網(wǎng)站開發(fā),而且對SEO,網(wǎng)站推廣都有好處。
一般最基礎(chǔ)的php網(wǎng)站結(jié)構(gòu)涉及圖片、CSS文件、JS文件、第三方組件、管理后臺等內(nèi)容,相對應(yīng)的,基礎(chǔ)的php目錄框架結(jié)構(gòu)也涉及這些內(nèi)容,這些目錄命名時(shí)也有規(guī)范,比如
圖片目錄:images或者pic
CSS目錄:css
JS目錄:js
第三方組件目錄:libs或者include,下一級目錄可以根據(jù)具體的組件名定義目錄名
管理目錄:一般都是admin,單位了安全起見,你可以另起一個(gè)目錄名或者對admin目錄設(shè)置密碼保護(hù)。如何對訪問目錄設(shè)置密碼保護(hù)?
特別提醒:對于網(wǎng)站的框架目錄結(jié)構(gòu),事先要做好規(guī)劃,為了對搜索引擎友好便于網(wǎng)站推廣,建議目錄結(jié)構(gòu)層次不要太深,二三級目錄結(jié)構(gòu)就可以了。
另外如果你采用模板,可以創(chuàng)建模板目錄,比如將目錄命名為tpl,如果使用第三方模板引擎,比如smarty,你可以根據(jù)需要自行決定是否要另設(shè)目錄。php基礎(chǔ)教程:Smarty安裝教程
對于中等規(guī)模的網(wǎng)站,你也可以根據(jù)網(wǎng)站功能劃分網(wǎng)站目錄框架結(jié)構(gòu),比如按照頻道等。
php文件命名規(guī)范
良好的php文件命名規(guī)范也是php開發(fā)規(guī)范的要素,有助于記憶,便于管理,php網(wǎng)站程序文件的命名也有一定的規(guī)則,比如
php網(wǎng)站首頁文件命名規(guī)范:index.php或index.html
CSS文件命名規(guī)范:主CSS文件命名為style.css,另外你也可以針對具體的模塊或者頻道命名,比如用于用戶的CSS文件,可以定義為user_style.css或者u_style.css
JS文件命名規(guī)范:主JS文件命名為main.js或major.js,其他的JS文件命名,你可以根據(jù)具體的頁面或者特定的對象命名,比如首頁JS文件可以命名為index.js,服務(wù)于用戶登錄的JS文件可以命名為user_login.js等。
網(wǎng)站配置文件命名規(guī)范:config.php或default_config.php等
文件命名特別提醒:在對php文件進(jìn)行命名時(shí)考慮到可移植性,一律請使用小寫命名,另外與網(wǎng)站目錄名命名一樣,文件命名時(shí)可以采用兩種方式,一種可以使用拼音命名具體的文件,一種可以使用簡單明了的英語單詞命名文件,切勿隨便命名,導(dǎo)致今后維護(hù)混亂。
php代碼書寫規(guī)范
良好的php代碼規(guī)范,有助于php入門學(xué)習(xí)者從你寫的php代碼中受益,也有助于你今后的代碼維護(hù)。
1、對于所寫的php代碼,添加必要的代碼注釋,同時(shí)代碼注釋要規(guī)范,更多基礎(chǔ)php代碼書寫規(guī)范,請參考php基本語法教程
2、保持良好的php代碼書寫規(guī)范,合理使用縮進(jìn),保持代碼美觀。
3、使用賦值符時(shí)變量名、賦值符、值之間以空格分隔,即
復(fù)制代碼 代碼如下:
<?
$leapsoulcn = "歡迎訪問php網(wǎng)站教程網(wǎng),此節(jié)主要介紹php開發(fā)規(guī)范之php代碼規(guī)范";
?>
4、在書寫if、switch、函數(shù)代碼時(shí),務(wù)必保持大括號匹配,即
復(fù)制代碼 代碼如下:
<?
if(){
......
}
?>
或者
復(fù)制代碼 代碼如下:
<?
if()
{
......
}
?>
5、命名變量名或者函數(shù)名時(shí)注意代碼書寫規(guī)范,可以使用拼音、英語單詞、縮寫等形式,推薦以英語單詞作為php代碼命名規(guī)范,對于兩個(gè)單詞以上的以下劃線連接或者其中一個(gè)單詞首字母大寫的形式,即
復(fù)制代碼 代碼如下:
<?
$web_name = "php網(wǎng)站開發(fā)教程網(wǎng)";
$webUrl = "http://www.jb51.NET";
function userLogin()
{
}
?>
以上就是基礎(chǔ)的php代碼規(guī)范,對于php初學(xué)者學(xué)習(xí)php會有所幫助。養(yǎng)成良好的php代碼規(guī)范會讓開發(fā)者受益一生。
至此,php開發(fā)規(guī)范手冊之php代碼規(guī)范就介紹完了,良好的網(wǎng)站框架目錄構(gòu)建能力、php文件命名規(guī)范和php代碼書寫規(guī)范需要自己在不斷的開發(fā)中積累和養(yǎng)成,同時(shí)這些開發(fā)規(guī)范也有助于伙伴之間的合作,有助于php入門學(xué)習(xí)者學(xué)習(xí)你的php代碼。
php技術(shù):PHP開發(fā)規(guī)范手冊之PHP代碼規(guī)范詳解,轉(zhuǎn)載需保留來源!
鄭重聲明:本文版權(quán)歸原作者所有,轉(zhuǎn)載文章僅為傳播更多信息之目的,如作者信息標(biāo)記有誤,請第一時(shí)間聯(lián)系我們修改或刪除,多謝。