PHP 開源軟件《個(gè)人管理系統(tǒng)》——技術(shù)規(guī)范
介紹
做這個(gè)開源系統(tǒng),一直沒有做開發(fā)文檔,有點(diǎn)對(duì)不住大家,今天我把技術(shù)規(guī)范寫一下。
目錄結(jié)構(gòu)
訪問方式
http://localhost/index.php?r=模塊名稱_控制器名稱_方法或http://localhost/index.php?module=模塊名稱&controller=控制器名稱&action=方法名稱
默認(rèn)值是:模塊名稱:Default,控制器名稱:Page,方法名稱:index
命名規(guī)范
1)類文件都是以.class.php為后綴,使用駝峰法命名,并且首字母大寫。
2)類名要體現(xiàn)文件路徑
3)核心文件要放置在lib/Core/目錄下面,這時(shí)候你不需要require里面的文件,直接使用就可以。
4)函數(shù)的命名使用小寫字母和下劃線的方式
5)方法的命名使用駝峰法如validClientIp,私有方法使用下劃線'_',如_insertIP()。
6)常量以大寫字母加下劃線命名,如DB_HOST。
7)對(duì)內(nèi)部變量的命名沒有強(qiáng)制規(guī)范,可以根據(jù)個(gè)人喜好來(lái)命名。但個(gè)人建議方法參數(shù)變量我們使用駝峰法,內(nèi)部參數(shù)使用小寫字母和下劃線命名。
如:
- public function validAcount($userName){
- $user_name = $userName;
- }
8)模板文件以.tpl為后綴。
9)數(shù)據(jù)表和字段采用小寫加下劃線方式命名。如hh_ip的字段create_date
開發(fā)要求
1)MySQL***使用PDO進(jìn)行操作,因?yàn)榘踩?、性能比較高。
2)每次的數(shù)據(jù)庫(kù)讀取操作希望都使用explain進(jìn)行校驗(yàn),以便確認(rèn)命中索引。
打開日志
查看日志
查看是否命中索引
3)對(duì)于inner join,建議最多使用2個(gè)表。超過(guò)2個(gè),建議使用多個(gè)短select語(yǔ)句。
4)盡量用英文寫注釋,一是培養(yǎng)大家的英文能力;二是提高大家的命名能力。
總結(jié)
歡迎大家一起過(guò)來(lái)開發(fā),開發(fā)這個(gè)項(xiàng)目除了創(chuàng)作好的產(chǎn)品外,主要是為了技術(shù)交流,看看大家的好的技術(shù)。如果大家有更好的規(guī)范或者方法,不妨告知一、二。
QQ群:152448006
地址:
原文鏈接:http://www.cnblogs.com/baochuan/archive/2012/09/09/2677214.html
【編輯推薦】