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