如何寫出規范的代碼

jopen 12年前發布 | 17K 次閱讀 代碼 PHP開發

  原文地址:How to write good php code ?

  寫出優秀的代碼是一門藝術,要想如此,就必須在一開始就養成良好的編程習慣。良好的編程習慣不僅有助于項目初期的設計(如模塊化),還可以使你編寫的代碼更易于理解,從而使代碼的維護工作更輕松、更省力。不好的編程習慣則會造成代碼 bug,并且會使以后的維護工作困難重重。

  本文以 PHP 語言為例,介紹一些良好的編程習慣,希望能夠對你有所幫助。

  1. 規劃代碼結構

  優秀的 PHP 代碼應該有清晰的結構。PHP 面向對象的特性允許程序員將應用程序分解為函數或方法。如果代碼晦澀難懂,你也可以添加注釋,使代碼的功能一目了然。編碼時應盡量將前端代碼(HTML/CSS/JavaScript)與應用程序的服務端規則分開,或者你可以使用遵循 MVC 模式的 PHP 框架來構建你的應用程序。

  2. 編碼風格統一

  優秀的 PHP 代碼應該具備統一的風格。比如,為變量和函數制定統一的命名規則,為循環任務(比如數據庫存取、錯誤處理)制定統一的接入標準,或者保持有規律的代碼縮進,這些編碼習慣都可以讓別人閱讀代碼更加輕松。

  3. 可移植性

  優秀的 PHP 代碼應該具有可移植性。程序員應學會運用 PHP 現有的特性(比如魔術引號和短標簽等),應該了解產品需求,適應 PHP 的特點,保證寫出的 PHP 代碼具有可移植性和跨平臺性。

  4. 代碼安全性

  優秀的 PHP 代碼應該具有安全性。PHP5具有卓越的特性和靈活性,但應用程序的安全往往掌握在程序員的手中。作為專業的 PHP 開發人員,應該對安全漏洞有一些深入了解,常見的安全漏洞有跨站腳本攻擊(XSS)、跨站請求偽造(CSRF)、代碼注入漏洞和字符編碼漏洞等。使用 PHP 中的特定功能和函數(比如 mysql_real_escape_string 等)可以幫助程序員寫出安全的代碼。

  5. 添加注釋

  代碼注釋是代碼中的重要組成部分,它解釋了函數運行的目的,這種注釋會在代碼以后的維護中提供非常有用的幫助。

  6. 避免簡寫標記

  應使用完整的起始標記,不推薦使用簡寫的起始標記。

  7. 用單引號代替雙引號

  由于 PHP 會對雙引號中的內容進行變量搜索,為了避免這種搜索帶來的性能影響,程序員應該使用單引號引用字符串。

  8. 轉義輸出

  應該在 htmlspecialchars 函數中使用 ENT_QUOTES 參數,保證單引號(')也可以被轉義。盡管沒有規定必須這樣做,但這是一個好習慣。

  9. 使用逗號隔開字符串輸出

  字符串連接符(.)可以將單一的字符串傳遞給 echo 語句進行輸出,與之相比,逗號可以實現 echo 語句中字符串的分別輸出,這對 PHP 來說是一個性能改善。

  10. 在輸出前檢查傳遞值

  應該記得在輸出前檢查$_GET['query'] 的傳遞值。使用 isset 函數或是 empty 函數可以檢查變量值是否為空。

來自: www.iteye.com

 本文由用戶 jopen 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!