PHP 開源軟件《個人管理系統》——技術規范


 
介紹
 
  做這個開源系統,一直沒有做開發文檔,有點對不住大家,今天我把 技術規范寫一下。
 
目錄結構
 
  

 

訪問方式
 
  http://localhost/index.php?r=模塊名稱_控制器名稱_方法
  http://localhost/index.php?module=模塊名稱&controller=控制器名稱&action=方法名稱
 
默認值是:模塊名稱:Default,控制器名稱:Page,方法名稱:index
 
命名規范
 
  1)  類文件都是以.class.php為后綴,使用駝峰法命名,並且首字母大寫。

  2)  類名要體現文件路徑

  3)  核心文件要放置在lib/Core/目錄下面,這時候你不需要require里面的文件,直接使用就可以。

  4)  函數的命名使用小寫字母和下划線的方式

  5)  方法的命名使用駝峰法如validClientIp,私有方法使用下划線'_',如_insertIP()。

  6)  常量以大寫字母加下划線命名,如DB_HOST。

  7)  對內部變量的命名沒有強制規范,可以根據個人喜好來命名。但個人建議方法參數變量我們使用駝峰法,內部參數使用小寫字母和下划線命名。
    如:public function validAcount($userName){
        $user_name = $userName;
      }
  8)  模板文件以.tpl為后綴。

  9)  數據表和字段采用小寫加下划線方式命名。如hh_ip的字段create_date

 
開發要求
 
  1)MySQL最好使用PDO進行操作, 因為安全性、性能比較高。

  2)每次的數據庫讀取操作希望都使用explain進行校驗,以便確認命中索引。
打開日志

                                  查看日志

                                   查看是否命中索引

  3)對於inner join,建議最多使用2個表。超過2個,建議使用多個短select語句。
  4)盡量用英文寫注釋,一是培養大家的英文能力;二是提高大家的命名能力。
  5)大家統一使用utf-8的編碼方式。——這玩意好像現在很多新系統都這么干。(淘寶怪怪的,竟然用gbk,每次使用他們的接口我都iconv一下,麻煩不麻煩!)
  6)禁止使用全局函數。
 
總結
 
  歡迎大家一起過來開發,開發這個項目除了創作好的產品外,主要是為了技術交流,看看大家的好的技術。如果大家有更好的規范或者方法,不妨告知一、二。
  QQ群:152448006
  地址:
 
 
  大家進入之后,給我一個gmail帳號,然后我給大家分配一個新帳號給你。
如  
  

 
 
推薦
 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM