讓代碼分段和縮進(jìn)

       一種提高代碼可讀性的方法是給代碼分段，換句話說(shuō)，就是在代碼塊內(nèi)讓代碼縮進(jìn)。所有在括號(hào) {和 }之內(nèi)的代碼，構(gòu)成一個(gè)塊。基本思想是，塊內(nèi)的代碼都應(yīng)統(tǒng)一地縮進(jìn)去一個(gè)單位�？s進(jìn)由四個(gè)空格組成，禁止使用制表符 TAB 。

       一行 80 字符以內(nèi)是比較合適，在有些情況下，長(zhǎng)點(diǎn)也可以, 但最多為 120 個(gè)字符。
行結(jié)束標(biāo)志,行結(jié)束標(biāo)志遵循 Unix 文本文件的約定，行必需以單個(gè)換行符（LF）結(jié)束。換行符在文件中表示為 10，或16進(jìn)制的 0x0A。
       注：不要使用 蘋(píng)果操作系統(tǒng)的回車（0x0D）或 Windows 電腦的回車換行組合如（0x0D,0x0A）。
 
在代碼中使用空白
       在代碼中加入幾個(gè)空行，也叫空白，將代碼分為一些小的、容易理解的部分，可以使它更加可讀。建議采用一個(gè)空行來(lái)分隔代碼的邏輯組，例如控制結(jié)構(gòu)，采用兩個(gè)空行來(lái)分隔成員函數(shù)定義。沒(méi)有空白的代碼很難讀，很難理解。
 
遵循30秒法則
       其他的程序員應(yīng)能在少于 30 秒鐘的時(shí)間內(nèi)完全理解你的成員函數(shù)，理解它做什么，為什么這樣做，它是怎樣做的。如果他們做不到，說(shuō)明你的代碼太難維護(hù)，應(yīng)加以改進(jìn)。30 秒鐘，明明白白。 一個(gè)好的經(jīng)驗(yàn)法則是：如果一個(gè)成員函數(shù)一個(gè)屏幕裝不下，那么它就很可能太長(zhǎng)了。
 
每行只做一件事情
        每一行代碼只做一件事情。在依賴于穿孔卡片的計(jì)算機(jī)發(fā)展的早期，想讓一行代碼完成盡量多的功能的想法是可以理解的。若想在一行里做多件事情，就會(huì)使代碼難于理解。為什么要這樣呢？我們應(yīng)使代碼盡量容易理解，從而更容易維護(hù)和改進(jìn)。正如同一個(gè)成員函數(shù)應(yīng)該并且只能做一件事一樣，一行代碼也只應(yīng)做一件事情。
此外，應(yīng)讓代碼在一個(gè)屏幕內(nèi)可見(jiàn)。 也不應(yīng)向右滾動(dòng)編輯窗口來(lái)讀取一整行代碼，包括含有行內(nèi)注釋語(yǔ)句的代碼。
 
說(shuō)明運(yùn)行順序
        提高代碼可讀性的一個(gè)相當(dāng)簡(jiǎn)單的方法是使用圓括號(hào)來(lái)說(shuō)明PHP代碼運(yùn)行的準(zhǔn)確順序。如果為了理解你的源碼而必須了解編程語(yǔ)言的操作順序，那么這說(shuō)明源碼中一定有什么重要的東西做的不對(duì)。 這大多是在 AND 或者 OR 其它幾個(gè)比較關(guān)系處產(chǎn)生的邏輯比較上的問(wèn)題。
        注意：如果你象前文所建議的那樣，采用短小單獨(dú)的命令行，那么就不會(huì)產(chǎn)生這個(gè)問(wèn)題。
 公共和保護(hù)接口最小化原則     面向?qū)ο蟪绦蛟O(shè)計(jì)的基本點(diǎn)之一是最小化一個(gè)類的公共接口。這樣做有幾個(gè)理由：
   1  可學(xué)習(xí)性。要了解如何使用一個(gè)類，只需了解它的公共接口即可。公共接口越小，類越容易學(xué)習(xí)。
  2  減少耦合。當(dāng)一個(gè)類的實(shí)例向另一個(gè)類的實(shí)例或者直接向這個(gè)類發(fā)送一條消息時(shí)，這兩個(gè)類變得耦合起來(lái)。最小化公共接口意味著將耦合的可能降到最低。
  3 更大的靈活性。這直接與耦合相聯(lián)系。一旦想改變一個(gè)公共接口的成員函數(shù)的實(shí)現(xiàn)方法，如你可能想修改成員函數(shù)的返回值，那么你很可能不得不修改所有調(diào)用了該成員函數(shù)的代碼。公共接口越小，封裝性就越大，代碼的靈活性也越大。
    4 盡力使公共接口最小化這一點(diǎn)明顯地很值得你的努力，但通常不明顯的是也應(yīng)使被保護(hù)接口最小化�；�本思想是，從一個(gè)子類的角度來(lái)看，它所有超類的被保護(hù)接口是公共的。任何在被保護(hù)接口內(nèi)的成員函數(shù)可被一個(gè)子類調(diào)用。所以，出于與最小化公共接口同樣的理由，應(yīng)最小化類的被保護(hù)接口。
 
    首先定義公共接口。大多數(shù)有經(jīng)驗(yàn)的開(kāi)發(fā)者在開(kāi)始編寫(xiě)類的代碼之前就先定義類的公共接口。 第一，如果你不知道一個(gè)類要完成怎樣的服務(wù)/行為，你仍有一些設(shè)計(jì)工作要做。第二，這樣做使這個(gè)類很快地初具雛形，以便其他有賴于該類的開(kāi)發(fā)者在“真正的”類被開(kāi)發(fā)出來(lái)以前至少可以用這個(gè)雛形開(kāi)始工作。 第三，這種方法給你提供了一個(gè)初始框架，圍繞著這個(gè)框架你構(gòu)造類
 

 給代碼注釋
       記�。喝绻�你的代碼不值得注釋，那么它就不值得保留。當(dāng)正確地使用了本文提到的注釋標(biāo)準(zhǔn)和方針，就可以大幅度地提高代碼質(zhì)量。
 
      這是煙寒網(wǎng)絡(luò)團(tuán)隊(duì)多年從事網(wǎng)站建設(shè)工作以來(lái)，形成的一套規(guī)范，希望同業(yè)共享，提高網(wǎng)站建設(shè)質(zhì)量。

---

---

分享聯(lián)系我們

掃二維碼與項(xiàng)目經(jīng)理溝通 我們?cè)谖⑿派?4小時(shí)期待你的聲音

感謝您的關(guān)注分享“南寧煙寒網(wǎng)絡(luò)公司網(wǎng)站建設(shè)團(tuán)隊(duì)編碼規(guī)范”
煙寒網(wǎng)絡(luò)真誠(chéng)為您服務(wù) ，點(diǎn)擊客服直接咨詢下單.

立即咨詢