TP的命名規範

ThinkPHP的命名規範,可供參考。

  • 類文件都是以.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 這樣的數據表字段可能會被過濾。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章