17joys專案程式碼的命名規範
每個專案都會有相關的開發文件,其中一個非常有用的文件就是程式碼編寫規範。
下面是使用ThinkPHP應該儘量遵循的命名規範,請大家編寫時務必注意,養成良好的程式碼編寫習慣是做好一個程式設計師非常關鍵的一步:
- 類檔案都是以.class.php為字尾(這裡是指的ThinkPHP內部使用的類庫檔案,不代表外部載入的類庫檔案),使用駝峰法命名,並且首字母大寫,例如DbMysql.class.php。
- 函式、配置檔案等其他類庫檔案之外的一般是以.php為字尾(第三方引入的不做要求)。
- 確保檔案的命名和呼叫大小寫一致,是由於在類Unix系統上面,對大小寫是敏感的(而ThinkPHP在除錯模式下面,即使在Windows平臺也會嚴格檢查大小寫)。
- 類名和檔名一致(包括上面說的大小寫一致),例如 UserAction類的檔案命名是UserAction.class.php, InfoModel類的檔名是InfoModel.class.php,
- 函式的命名使用小寫字母和下劃線的方式,例如 get_client_ip
- Action控制器類以Action為字尾,例如 UserAction、InfoAction
- 模型類以Model為字尾,例如UserModel、InfoModel
- 方法的命名使用駝峰法,並且首字母小寫,例如 getUserName
- 屬性的命名使用駝峰法,並且首字母小寫,例如 tableName
- 以雙下劃線“__”打頭的函式或方法作為魔法方法,例如 __call 和 __autoload
- 常量以大寫字母和下劃線命名,例如 HAS_ONE和 MANY_TO_MANY
- 配置引數以大寫字母和下劃線命名,例如HTML_CACHE_ON
- 語言變數以大寫字母和下劃線命名,例如MY_LANG,以下劃線打頭的語言變數通常用於系統語言變數,例如 _CLASS_NOT_EXIST_。
- 資料表和欄位採用小寫加下劃線方式命名,例如 think_user 和 user_name
另外一點,ThinkPHP預設使用UTF-8編碼,所以請確保你的程式檔案採用UTF-8編碼格式儲存,並且去掉BOM資訊頭(去掉BOM頭資訊有很多方式,不同的編輯器都有設定方法,也可以用工具進行統一檢測和處理)。
作者:@ 修訂1.0 2010-03
樂學PHP學院是國內專業的PHP培訓機構,天津最好的PHP培訓機構,擁有完整全面的PHP培訓課程體系,使用自行開發的PHP內容管理系統作為授課案例,真實專案教學,還提供PHP教程、PHP影片、PHP人才、PHP開發等服務!
本文樂學PHP版權所有,未經批准轉載必究。
[@more@]來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/23714519/viewspace-1032845/,如需轉載,請註明出處,否則將追究法律責任。
相關文章
- 我的專案命名規範
- Android 程式碼規範 - 命名規範Android
- Android程式碼規範:命名規範Android
- 統一規範化專案的命名風格
- 淺談專案程式碼規範
- 統一規範化程式碼的命名風格
- 用BEM命名規範組織CSS程式碼CSS
- 檔案/資源命名規範
- android檔案命名規範Android
- iOS 專案架構與程式碼規範iOS架構
- C#程式碼識別符號命名規範C#符號
- iOS程式碼規範之駝峰命名法camelCaseiOS
- 前端工程程式碼規範(一)——命名規則與工程約定前端
- 【iOS 搭建基礎框架】編碼規範 (命名規範篇)iOS框架
- PHP 命名規範PHP
- JavaScript 命名規範JavaScript
- PHP命名規範PHP
- CSS命名規範CSS
- SqlServer命名規範SQLServer
- Google命名規範Go
- java命名規範Java
- C#程式設計命名規範C#程式設計
- 程式設計命名規範(網文)程式設計
- Android 命名規範 (提高程式碼可以讀性)Android
- Java中的命名規範。Java
- 前端開發規範:命名規範、html規範、css規範、js規範前端HTMLCSSJS
- 『前端規範化』CSS命名規範化前端CSS
- 前端專案git操作命名規範和協作開發流程前端Git
- 前端規範之vue 專案規範前端Vue
- Python命名規範Python
- CSS — BEM 命名規範CSS
- 前端命名基本規範前端
- css 命名規範 BEMCSS
- Android命名規範Android
- C#命名規範C#
- 在編輯model層時,如何命名規範整潔的程式碼?
- Vue專案使用eslint + prettier規範程式碼風格VueEsLint
- vue-cli3專案配置eslint程式碼規範VueEsLint