代碼命名規范


代碼規范化基本上有七大原則:

1) 空行    2) 空格    3) 成對書寫   4) 縮進  5) 對齊  6) 代碼行    7) 注釋

另外,還需要一系列的原則,如:

良好的工程結構
目錄結構要清晰,例如很多框架采用了mvc設計思想。模型放一個目錄,視圖放一個目錄,控制器放一個目錄。大家可以下載相關的mvc設計思想的框架,例如:ThinkPHP、Laravel。

使用DRY原則

不要重復你的代碼。拆分可重用函數或類,使用常量定義。

使用有意義並一致命名

不要使用拼音命名,不要沒有明確含義的命名。

變量命名:變量的名詞性(形容詞+名詞),長名字可用下划線連接。

函數名:小駝峰式(如:getUserInfo())。函數的動詞性(動詞+形容詞+名詞;謂語+賓語)

類的命名:大駝峰式(如:UserInfo)類的名詞性:如:OrderModel。不可出現下划線。

適當留空和必要縮進

使用tab鍵縮進(不可使用4個空格來代替縮進)。

留空(使用空格、換行、空行)

避免深嵌套

嵌套不應該大於3層。函數不應該有多個出口。

添加應有的注釋

注釋塊/**/

文件頭:名詞,版權,作者。

類:類作用解釋。

函數:函數作用,入參數,返回內容。

注釋行 //:幫助記憶

代碼說明:一般用於對某個邏輯塊的說明。

結束提示:常用於if、switch、while邏輯體結束說明。

待開發提示

調試提示

變量聲明和初始化

避免聲明的局部變量覆蓋上一級聲明的變量

使用前必須將變量初始化

變量名盡量體現數據類型

永遠不要相信用戶

天真的用戶:只要有輸入框,就會出現各種輸入內容

不懷好意者:會想辦法通過輸入注入惡意內容

防范措施:前端對輸入進行校驗。后端對於輸入校驗必不可少,不能假設前端做了正確的校驗。存在你也不知道的入口。攻擊者會直接通過編造請求的方式進行提交。防止各種注入。

合理使用緩存機制

建議使用緩存機制緩存獲得更好的性能。例如:redis、memcached等。

避免代碼的Copy和Paste

沒有理解代碼的含義,就呆板的拷貝復制。拷貝來的代碼未必就是對的。如果有重復代碼,意味着可以拆分出一個功能函數。

盡量多使用框架
框架的目的是為了提高開發效率。框架是前輩們知識和經驗積累而來,是被證明了的成熟解決方案。絕大數框架基於MVC(模型視圖控制器)架構理念而開發。選擇適合自己的框架。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM