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