開發規范

開發框架：Thinkphp6.0最新版，文檔地址：https://www.kancloud.cn/manual/thinkphp6_0/1037479

請理解并盡量遵循以下命名規范，可以減少在開發過程中出現不必要的錯誤。

ThinkPHP6.0遵循PSR-2命名規范和PSR-4自動加載規范，并且注意如下規范：

命名規范

目錄和文件

  • 目錄使用小寫+下劃線；
  • 類庫、函數文件統一以.php為后綴；
  • 類的文件名均以命名空間定義，并且命名空間的路徑和類庫文件所在路徑一致；
  • 類（包含接口和Trait）文件采用駝峰法命名（首字母大寫），其它文件采用小寫+下劃線命名；
  • 類名（包括接口和Trait）和文件名保持一致，統一采用駝峰法命名（首字母大寫）；

函數和類、屬性命名

  • 類的命名采用駝峰法（首字母大寫），例如 User、UserType；
  • 函數的命名使用小寫字母和下劃線（小寫字母開頭）的方式，例如 get_client_ip；
  • 方法的命名使用駝峰法（首字母小寫），例如 getUserName；
  • 屬性的命名使用駝峰法（首字母小寫），例如 tableName、instance；
  • 特例：以雙下劃線__打頭的函數或方法作為魔術方法，例如 __call 、__autoload；

變量、常量和配置

  • 常量以大寫字母和下劃線命名，例如 APP_PATH；
  • 配置參數以小寫字母和下劃線命名，例如 url_route_on 和 url_convert；
  • 環境變量定義使用大寫字母和下劃線命名，例如 APP_DEBUG；
  • 變量命名使用駝峰法，常規變量首字母小寫，如 $myName；
  • 數組定義使用中括號，杜絕使用array。如：$arr = ['color' => 'red'];

代碼規范

  • 格式化代碼，保持代碼整潔、易讀。
  • 合理運用空行，空行可以用來隔開相對獨立的代碼塊，有利于閱讀和理解。但是不要使用超過一行的空行。
  • 拆分較長的類，較長的方法。單個類或者方法不易過長，可拆分為多個子類或方法。