摘要:統一的編碼規范編碼規范往簡單說其實就是三個方面換行空格變量命名放在里面,還有一些附加的地方,比如關鍵字大小寫,語法糖的使用與等的問題。這些都是規范代碼的重要手段。推廣給你的隊友團隊項目中,隊友的配合對整個代碼的規范起著決定性的作用。
1. 統一的編碼規范
編碼規范往簡單說其實就是三個方面:
換行
空格
變量命名
放在 PHP 里面,還有一些附加的地方,比如關鍵字大小寫,語法糖的使用(array() 與 [] 等)的問題。之前整理過 PSR 的標準,也找過 php-cs-fixer 這樣的工具。這些都是規范代碼的重要手段。有統一的標準,配合上工具的檢查,形成統一的編碼約束不是什么難題。
沒有規范,不同的人甚至同一個人在空格、換行和命名上都有可能是十分隨意的。代碼一長,回使整個文件看起來無比雜亂。
典型的例子比如:if 和 else 的組合,可以寫出無數種風格,比如:
再比如變量函數命名的問題上,各種混搭風格層出不窮:
這里并不探討各種寫法的優缺點,只是風格需要保持統一,不要混用。
2. 良好的編碼習慣如果你仔細看過 PSR 的標準,可能也會注意到某些地方其實是標準無法涉及到的。比如一個超長的表達式在什么時候換行,如何縮進等。
這里涉及到的就是編碼習慣的約束問題。
比如方法的鏈式的調用的問題,比如某些數據庫查詢的封裝:
db->select("id")->where("a", 1) ->groupBy("a")->orderBy("id", "DESC")->result(); # 這種情況下我建議是一個條件一行,保持縮進 $result = $this->db->select("id") ->where("a", 1) ->groupBy("a") ->orderBy("id", "DESC") ->result();還有數組定義,某些數組成員字符串很長的情況下的寫法:
3. 尋找最優的寫法寫代碼的過程中,最優的寫法和編碼習慣又不是同一件事情。這里要說的指的是如何遵循 PHP 的語言特性或者框架的特征,充分發揮語言和框架的能力來減少冗余。
比如在獲取前端傳入的參數的時候,很多時候能見到這樣的代碼:
更有甚者一些框架將前端傳入的參數封裝了一層,比如 $this->request->data["param"],如果再去用 isset 或者 array_key_exists 判斷,整個獲取參數的語句就會變得很長。
某些情況下使用三元運算符的時候需要注意 ?: 是可以合并使用的。
其實我們應該去嘗試封裝這種寫法,防止同樣的變量出現在一個語句中多次的情況。對于默認值的賦予,可以調研框架是否有封裝提供,或者通過強制類型轉換的方式進行。
還有一種情況是條件和循環嵌套的時候。比如從數組里抽取某一個字段,或者對某一個字段的值進行處理的時候,善用 array_map 以及引用(&)往往能節省不少工作量。但是使用的時候也要注意數組指針最后的位置。
在根據條件返回結果時,需要善用 return。還有就是合理的抽象與封裝。
4. review 自己的代碼除了以上提到的在日常開發中需要注意的一些問題。還有就是事后的工作。
我相信很多人在看自己以前的代碼的時候都有一種其實有更好的寫法的感覺。隨著時間的推移自己總會有更豐富的閱歷,更多的想法。偶爾 review 自己的代碼也是對過去的總結,也許會有新的感知。
5. 推廣給你的隊友團隊項目中,隊友的配合對整個代碼的規范起著決定性的作用。一個團隊中有一個人不遵守規范,而又要到處修改代碼的時候,很快就能破壞到所有的約束。
有統一的標準,有良好的執行力才能完成這件工作。
私博地址:http://0x1.im
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/21378.html
摘要:將代碼寫的簡潔并且易讀易懂是每一位優秀的所應該具備的基本功。前幾天在上看到這個項目,感覺很有收獲,于是在這里記錄一下。 將代碼寫的簡潔并且易讀易懂是每一位優秀的coder所應該具備的基本功。 前幾天在github上看到clean-code-php這個項目,感覺很有收獲,于是在這里記錄一下。 使用有意義并且可讀的變量名稱 Bad: $ymdstr = $moment->format(y-...
摘要:使用和在中,通過為屬性或方法設置和關鍵字可以實現對屬性或方法的可見性控制。你的繼承表達了一個對等比如人類是動物的關系,不是包含的關系比如用戶具有用戶詳情你能從基類中復用代碼你想通過修改全局類來對所有派生類進行修改。 使用getter和setter 在 PHP 中,通過為屬性或方法設置 public, protected 和 private 關鍵字可以實現對屬性或方法的可見性控制。不過,...
摘要:超過三個參數會導致參數之間的組合過多,你必須對每個單獨的參數測試大量不同的情況。拆分這些函數,可以讓代碼可重用性更高且更易測試。 函數參數不要超過兩個 限制函數的參數數量是非常重要的,因為它使你的函數更容易測試。超過三個參數會導致參數之間的組合過多,你必須對每個單獨的參數測試大量不同的情況。 沒有參數是最理想的情況,一個或兩個參數是可以接受的,三個以上則是應該避免的。這很重要的。如果你...
摘要:是推薦的便于記憶的首字母簡寫,它代表了命名的最重要的五個面對對象編碼設計原則單一職責原則開閉原則里氏替換原則接口隔離原則依賴反轉原則單一職責原則修改一個類應該只為一個理由。別寫重復代碼這條原則大家應該都是比較熟悉了。 SOLID 是Michael Feathers推薦的便于記憶的首字母簡寫,它代表了Robert Martin命名的最重要的五個面對對象編碼設計原則 S: 單一職責原則 ...
摘要:權限中心的依賴聲明聲明依賴關系檢查代碼規范聲明開發依賴命名空間檢查代碼規范,執行單元測試。單元測試持續交付一切都如此的完美,沒有測試,又如何可以證明這件事情的完美,又如何可以保障交付的質量。 序 權限管理是無線運營系統中的核心模塊,通過訪問控制策略的配置,來約定人與資源的訪問關系。 本文著重講解如何通過PHP來構建一個靈活、通用、安全的權限管理系統。 關于權限 首先我們來聊聊權限。 權...
閱讀 3421·2021-10-20 13:49
閱讀 2793·2021-09-29 09:34
閱讀 3691·2021-09-01 11:29
閱讀 3081·2019-08-30 11:01
閱讀 838·2019-08-29 17:10
閱讀 866·2019-08-29 12:48
閱讀 2777·2019-08-29 12:40
閱讀 1348·2019-08-29 12:30