PHP代碼、文件命名規範

時間 2019-11-30

標籤 php 代碼文件命名規範欄目 PHP 简体版

原文原文鏈接

命名規範

開發的過程當中應該儘可能遵循下列命名規範：php

類文件都是以.class.php爲後綴（這裏是指的ThinkPHP內部使用的類庫文件，不表明外部加載的類庫文件），使用駝峯法命名，而且首字母大寫，例如 DbMysql.class.php；

類的命名空間地址和所在的路徑地址一致，例如 Home\Controller\UserController類所在的路徑應該是 Application/Home/Controller/UserController.class.php；

確保文件的命名和調用大小寫一致，是因爲在類Unix系統上面，對大小寫是敏感的（而ThinkPHP在調試模式下面，即便在Windows平臺也會嚴格檢查大小寫）；

類名和文件名一致（包括上面說的大小寫一致），例如 UserController類的文件命名是UserController.class.php， InfoModel類的文件名是InfoModel.class.php，而且不一樣的類庫的類命名有必定的規範；

函數、配置文件等其餘類庫文件以外的通常是以.php爲後綴（第三方引入的不作要求）；

函數的命名使用小寫字母和下劃線的方式，例如 get_client_ip；

方法的命名使用駝峯法，而且首字母小寫或者使用下劃線「_」，例如 getUserName，_parseType，一般下劃線開頭的方法屬於私有方法；

屬性的命名使用駝峯法，而且首字母小寫或者使用下劃線「_」，例如 tableName、_instance，一般下劃線開頭的屬性屬於私有屬性；

以雙下劃線「__」打頭的函數或方法做爲魔法方法，例如 __call 和 __autoload；

常量以大寫字母和下劃線命名，例如 HAS_ONE和 MANY_TO_MANY；

配置參數以大寫字母和下劃線命名，例如HTML_CACHE_ON；

語言變量以大寫字母和下劃線命名，例如MY_LANG，如下劃線打頭的語言變量一般用於系統語言變量，例如 _CLASS_NOT_EXIST_；

對變量的命名沒有強制的規範，能夠根據團隊規範來進行；

ThinkPHP的模板文件默認是以.html 爲後綴（能夠經過配置修改）；

數據表和字段採用小寫加下劃線方式命名，並注意字段名不要如下劃線開頭，例如 think_user 表和 user_name字段是正確寫法，相似 _username 這樣的數據表字段可能會被過濾。

流程語句規範
html

全部流程語句的花括號都單獨佔據一行。理由：若是遇到較爲複雜的業務邏輯，花括號會出現不少的嵌套，這樣一來咱們會混淆個個對應的花括號！
sql

一、分支語句框架

 
         if 
         ( 
         $age 
         >= 18 &&  
         $age 
         <= 30)  
        
         { 
        
         echo 
         'young man' 
         ; 
        
         } 
        
         else 
         if 
         ( 
         $age 
         > 30 &&  
         $age 
         <= 60) 
        
         { 
        
         echo 
         'middle aged' 
         ; 
        
         } 
        
         else 
        
         { 
        
         echo 
         'old man' 
         ; 
        
         } 
        
         //下面這段代碼高手咱們一個問題，在if語句中，即便在能夠不要花括號的狀況下，花括號也是要寫上的 
        
         if 
         ( 
         $age 
         > 60) 
        
         { 
        
         echo 
         'I am very old' 
         ; 
        
         } 
        
         switch 
         ( 
         $status 
         ) 
        
         { 
        
         case 
         'forbiden' 
         ： 
        
         echo 
         'login forbidden' 
         ; 
        
         break 
         ; 
        
         case 
         'normal' 
         : 
        
         echo 
         'login in' 
         ; 
        
         break 
         ; 
        
         default 
         : 
        
         echo 
         'status is wrong' 
         ： 
        
         break 
         ; 
        
         }

二、循環語句ide

 
         while 
         ( 
         $condition 
         ) 
        
         { 
        
         statesments......; 
        
         } 
        
         foreach 
         ( 
         $arrayList 
         as 
         $arrayKey 
         =>  
         $arrayItem 
         ) 
        
         { 
        
         states......; 
        
         } 
        
         do 
        
         { 
        
         statements......;   
        
         } 
        
         while 
         ( 
         $condition 
         ) 
        
         for 
         ( 
         $start 
         ; condition; changenumber) 
        
         { 
        
         statements......; 
        
         }