涉及多個方面,比如PHP代碼規範、PHP檔案命名規範、網站開發流程、網站安全與維護等。
作為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代碼。