南寧煙寒網絡公司網站建設團隊編碼規范 admin 2009/7/12 10:00:00 讓代碼分段和縮進 一種提高代碼可讀性的方法是給代碼分段,換句話說,就是在代碼塊內讓代碼縮進。所有在括號 {和 }之內的代碼,構成一個塊。基本思想是,塊內的代碼都應統一地縮進去一個單位。縮進由四個空格組成,禁止使用制表符 TAB 。 一行 80 字符以內是比較合適,在有些情況下,長點也可以, 但最多為 120 個字符。行結束標志,行結束標志遵循 Unix 文本文件的約定,行必需以單個換行符(LF)結束。換行符在文件中表示為 10,或16進制的 0x0A。 注:不要使用 蘋果操作系統的回車(0x0D)或 Windows 電腦的回車換行組合如(0x0D,0x0A)。 在代碼中使用空白 在代碼中加入幾個空行,也叫空白,將代碼分為一些小的、容易理解的部分,可以使它更加可讀。建議采用一個空行來分隔代碼的邏輯組,例如控制結構,采用兩個空行來分隔成員函數定義。沒有空白的代碼很難讀,很難理解。 遵循30秒法則 其他的程序員應能在少于 30 秒鐘的時間內完全理解你的成員函數,理解它做什么,為什么這樣做,它是怎樣做的。如果他們做不到,說明你的代碼太難維護,應加以改進。30 秒鐘,明明白白。 一個好的經驗法則是:如果一個成員函數一個屏幕裝不下,那么它就很可能太長了。 每行只做一件事情 每一行代碼只做一件事情。在依賴于穿孔卡片的計算機發展的早期,想讓一行代碼完成盡量多的功能的想法是可以理解的。若想在一行里做多件事情,就會使代碼難于理解。為什么要這樣呢?我們應使代碼盡量容易理解,從而更容易維護和改進。正如同一個成員函數應該并且只能做一件事一樣,一行代碼也只應做一件事情。此外,應讓代碼在一個屏幕內可見。 也不應向右滾動編輯窗口來讀取一整行代碼,包括含有行內注釋語句的代碼。 說明運行順序 提高代碼可讀性的一個相當簡單的方法是使用圓括號來說明PHP代碼運行的準確順序。如果為了理解你的源碼而必須了解編程語言的操作順序,那么這說明源碼中一定有什么重要的東西做的不對。 這大多是在 AND 或者 OR 其它幾個比較關系處產生的邏輯比較上的問題。 注意:如果你象前文所建議的那樣,采用短小單獨的命令行,那么就不會產生這個問題。 公共和保護接口最小化原則 面向對象程序設計的基本點之一是最小化一個類的公共接口。這樣做有幾個理由: 1 可學習性。要了解如何使用一個類,只需了解它的公共接口即可。公共接口越小,類越容易學習。 2 減少耦合。當一個類的實例向另一個類的實例或者直接向這個類發送一條消息時,這兩個類變得耦合起來。最小化公共接口意味著將耦合的可能降到最低。 3 更大的靈活性。這直接與耦合相聯系。一旦想改變一個公共接口的成員函數的實現方法,如你可能想修改成員函數的返回值,那么你很可能不得不修改所有調用了該成員函數的代碼。公共接口越小,封裝性就越大,代碼的靈活性也越大。 4 盡力使公共接口最小化這一點明顯地很值得你的努力,但通常不明顯的是也應使被保護接口最小化。基本思想是,從一個子類的角度來看,它所有超類的被保護接口是公共的。任何在被保護接口內的成員函數可被一個子類調用。所以,出于與最小化公共接口同樣的理由,應最小化類的被保護接口。 首先定義公共接口。大多數有經驗的開發者在開始編寫類的代碼之前就先定義類的公共接口。 第一,如果你不知道一個類要完成怎樣的服務/行為,你仍有一些設計工作要做。第二,這樣做使這個類很快地初具雛形,以便其他有賴于該類的開發者在“真正的”類被開發出來以前至少可以用這個雛形開始工作。 第三,這種方法給你提供了一個初始框架,圍繞著這個框架你構造類 給代碼注釋 記住:如果你的代碼不值得注釋,那么它就不值得保留。當正確地使用了本文提到的注釋標準和方針,就可以大幅度地提高代碼質量。 這是煙寒網絡團隊多年從事網站建設工作以來,形成的一套規范,希望同業共享,提高網站建設質量。 分享聯系我們 掃二維碼與項目經理溝通 我們在微信上24小時期待你的聲音 感謝您的關注分享“南寧煙寒網絡公司網站建設團隊編碼規范” 煙寒網絡真誠為您服務 ,點擊客服直接咨詢下單. 立即咨詢 我們服務 網站建設 高端網站建設服務商、相信品牌力量、相信知名企業;制作后收費13014982176! 微信小程序/微信公眾號 微信小程序 背靠10億流量,不論用戶需求是什么,都能被開發使用 一點創意,就能在“社交圈”中脫穎而出。 網站優化/SEO 讓您的網站更靠近排名位置,讓客戶更容易找到您,seo優化是一個漫長過程,整個網站營銷花最少的錢起最大的作用。