為了提高工作效率，保證開發的有效性和合理性，並最大程度提高程序代碼的可讀性和重複利用性，提高溝通效率，需要一份代碼編寫規範。
代碼規範的重要性
1、促進團隊合作。項目是由一個團隊來完成，如果沒有統一的代碼規範，那麼每個人的代碼必定風格迥異。多個人同時開發同一模塊，等到要整合代碼的時候也很頭疼，可讀性差。
2、減少Bug處理減少低級錯誤發生。再複雜的邏輯看起來也是很清晰。規則不統一，容易出錯。步調一致，減少細節思考。
3、降低維護成本方便後面的人進行代碼閱讀和維護，減少程序耦合性，方便在之前的模塊上擴展一些功能，可維護性高。
4、有助代碼審查代碼審查有據可依。減少代碼審查的工作量，統一度量標準。
代碼規範的要求
1、良好的工程結構
目錄結構要清晰，例如很多框架採用了mvc設計思想。
模型放一個目錄，視圖放一個目錄，控制器放一個目錄。
大家可以下載相關的mvc設計思想的框架，例如：ThinkPHP、Laravel。
2、使用DRY原則
不要重複你的代碼，拆分可重用函數或類，使用常量定義。
3、使用有意義並一致命名
不要使用拼音命名，不要沒有明確含義的命名。
變量命名：變量的名詞性（形容詞+名詞），長名字可用下劃線連接。
函數名：小駝峰式（如：getUserInfo()）。函數的動詞性（動詞+形容詞+名詞；謂語+賓語）
類的命名：大駝峰式（如：UserInfo）類的名詞性:如：OrderModel。不可出現下劃線。
4、避免深嵌套
嵌套不應該大於3層。函數不應該有多個出口。
5、添加應有的註釋
註釋塊/**/
類：類作用解釋。
函數：函數作用，入參數，返回內容。
註釋行 //：幫助記憶
代碼說明：一般用於對某個邏輯塊的說明。
結束提示：常用於if、switch、while邏輯體結束說明。
待開發提示
調試提示
避免聲明的局部變量覆蓋上一級聲明的變量
使用前必須將變量初始化
變量名儘量體現數據類型
7、合理使用緩存機制
建議使用緩存機制緩存獲得更好的性能。例如：redis、memcached等。
避免代碼的Copy和Paste
沒有理解代碼的含義，就呆板的拷貝複製。拷貝來的代碼未必就是對的。如果有重複代碼，意味著可以拆分出一個功能函數。
8、儘量多使用框架
框架的目的是為了提高開發效率。框架是前輩們知識和經驗積累而來，是被證明了的成熟解決方案。絕大數框架基於MVC(模型視圖控制器)架構理念而開發。選擇適合自己的框架。
閱讀更多 上海千鋒教育 的文章
