- 相關(guān)推薦
PHP代碼如何規(guī)范
對(duì)于PHP入門學(xué)習(xí)的童鞋來(lái)說(shuō),基礎(chǔ)是很重的,一定要打好基礎(chǔ)。那么大家知道PHP代碼如何規(guī)范呢?下面一起來(lái)看看!
了解PHP開(kāi)發(fā)規(guī)范可以少走很多彎路,網(wǎng)上各種PHP開(kāi)發(fā)規(guī)范也很多,我結(jié)合自身使用PHP的情況,來(lái)說(shuō)說(shuō)我所理解的PHP開(kāi)發(fā)規(guī)范,涉及多個(gè)方面,比如PHP代碼規(guī)范、PHP文件命名規(guī)范、網(wǎng)站開(kāi)發(fā)流程、網(wǎng)站安全與維護(hù)等。
作為PHP開(kāi)發(fā)規(guī)范的開(kāi)篇,我從一個(gè)純PHP開(kāi)發(fā)者的角度來(lái)說(shuō)說(shuō)我所認(rèn)為的PHP代碼規(guī)范,主要從PHP目錄框架結(jié)構(gòu)、PHP代碼書寫規(guī)范、PHP文件命名規(guī)范三個(gè)角度來(lái)闡述,希望對(duì)PHP入門學(xué)習(xí)者有所幫助。
合理建設(shè)PHP目錄框架結(jié)構(gòu)
我們知道在使用PHP進(jìn)行網(wǎng)站開(kāi)發(fā)之前,我們需要建設(shè)網(wǎng)站的目錄結(jié)構(gòu),網(wǎng)站目錄框架結(jié)構(gòu)設(shè)計(jì)得合理規(guī)范,不但有利于網(wǎng)站開(kāi)發(fā),而且對(duì)SEO,網(wǎng)站推廣都有好處。
一般最基礎(chǔ)的PHP網(wǎng)站結(jié)構(gòu)涉及圖片、CSS文件、JS文件、第三方組件、管理后臺(tái)等內(nèi)容,相對(duì)應(yīng)的,基礎(chǔ)的PHP目錄框架結(jié)構(gòu)也涉及這些內(nèi)容,這些目錄命名時(shí)也有規(guī)范,比如
圖片目錄:images或者pic
CSS目錄:css
JS目錄:js
第三方組件目錄:libs或者include,下一級(jí)目錄可以根據(jù)具體的組件名定義目錄名
管理目錄:一般都是admin,單位了安全起見(jiàn),你可以另起一個(gè)目錄名或者對(duì)admin目錄設(shè)置密碼保護(hù)。如何對(duì)訪問(wèn)目錄設(shè)置密碼保護(hù)?
特別提醒:對(duì)于網(wǎng)站的框架目錄結(jié)構(gòu),事先要做好規(guī)劃,為了對(duì)搜索引擎友好便于網(wǎng)站推廣,建議目錄結(jié)構(gòu)層次不要太深,二三級(jí)目錄結(jié)構(gòu)就可以了。
另外如果你采用模板,可以創(chuàng)建模板目錄,比如將目錄命名為tpl,如果使用第三方模板引擎,比如smarty,你可以根據(jù)需要自行決定是否要另設(shè)目錄。
對(duì)于中等規(guī)模的網(wǎng)站,你也可以根據(jù)網(wǎng)站功能劃分網(wǎng)站目錄框架結(jié)構(gòu),比如按照頻道等。
PHP文件命名規(guī)范
良好的PHP文件命名規(guī)范也是PHP開(kāi)發(fā)規(guī)范的要素,有助于記憶,便于管理,PHP網(wǎng)站程序文件的命名也有一定的規(guī)則,比如
PHP網(wǎng)站首頁(yè)文件命名規(guī)范:index.php或index.html
CSS文件命名規(guī)范:主CSS文件命名為style.css,另外你也可以針對(duì)具體的模塊或者頻道命名,比如用于用戶的CSS文件,可以定義為user_style.css或者u_style.css
JS文件命名規(guī)范:主JS文件命名為main.js或major.js,其他的JS文件命名,你可以根據(jù)具體的頁(yè)面或者特定的對(duì)象命名,比如首頁(yè)JS文件可以命名為index.js,服務(wù)于用戶登錄的JS文件可以命名為user_login.js等。
網(wǎng)站配置文件命名規(guī)范:config.php或default_config.php等
文件命名特別提醒:在對(duì)PHP文件進(jìn)行命名時(shí)考慮到可移植性,一律請(qǐng)使用小寫命名,另外與網(wǎng)站目錄名命名一樣,文件命名時(shí)可以采用兩種方式,一種可以使用拼音命名具體的文件,一種可以使用簡(jiǎn)單明了的英語(yǔ)單詞命名文件,切勿隨便命名,導(dǎo)致今后維護(hù)混亂。
PHP代碼書寫規(guī)范
良好的PHP代碼規(guī)范,有助于PHP入門學(xué)習(xí)者從你寫的PHP代碼中受益,也有助于你今后的代碼維護(hù)。
1、對(duì)于所寫的PHP代碼,添加必要的代碼注釋,同時(shí)代碼注釋要規(guī)范,更多基礎(chǔ)PHP代碼書寫規(guī)范,請(qǐng)參考PHP基本語(yǔ)法教程
2、保持良好的PHP代碼書寫規(guī)范,合理使用縮進(jìn),保持代碼美觀。
3、使用賦值符時(shí)變量名、賦值符、值之間以空格分隔,即
4、在書寫if、switch、函數(shù)代碼時(shí),務(wù)必保持大括號(hào)匹配,即
或者
5、命名變量名或者函數(shù)名時(shí)注意代碼書寫規(guī)范,可以使用拼音、英語(yǔ)單詞、縮寫等形式,推薦以英語(yǔ)單詞作為PHP代碼命名規(guī)范,對(duì)于兩個(gè)單詞以上的以下劃線連接或者其中一個(gè)單詞首字母大寫的形式,即
以上就是基礎(chǔ)的PHP代碼規(guī)范,對(duì)于PHP初學(xué)者學(xué)習(xí)PHP會(huì)有所幫助。養(yǎng)成良好的PHP代碼規(guī)范會(huì)讓開(kāi)發(fā)者受益一生。
至此,PHP開(kāi)發(fā)規(guī)范手冊(cè)之PHP代碼規(guī)范就介紹完了,良好的網(wǎng)站框架目錄構(gòu)建能力、PHP文件命名規(guī)范和PHP代碼書寫規(guī)范需要自己在不斷的開(kāi)發(fā)中積累和養(yǎng)成,同時(shí)這些開(kāi)發(fā)規(guī)范也有助于伙伴之間的合作,有助于PHP入門學(xué)習(xí)者學(xué)習(xí)你的PHP代碼。
【PHP代碼如何規(guī)范】相關(guān)文章:
如何正確發(fā)布PHP代碼08-03
如何閱讀php源代碼09-19
PHP如何編寫易讀的代碼10-25
PHP中如何實(shí)現(xiàn)crontab代碼05-30
如何寫出優(yōu)雅的PHP代碼07-24
如何在HTML中嵌入PHP代碼11-07
如何在cmd下面寫php代碼06-21
php代碼如何實(shí)現(xiàn)命令行執(zhí)行05-19
PHP代碼優(yōu)化技巧09-10