不可小覷的Web開發編碼規範

文章作者Andrey Prikaznov在DZone上分享了關於Web開發裏編碼規範的注意事項。編碼時間長的人總會遇到編碼格式標準化的問題,但是不同的項目裏需要使用不同的規則和風格來解決問題,甚至有的時候林林總總的繁雜事情會讓人頭腦發漲,那爲什麼不考慮一下標準化編碼呢?換句話說,編碼規範是一套規章制度:用來爲某一特定的編程語言的腳本語言推薦編程風格、方法和實踐。這些規範覆蓋方方面面,包括註釋、文件夾、文件組織、行首縮進、書面聲明、空格、命名規格、編程實踐和原則、構建最佳實踐等等。(以下是編譯內容)

在編碼過程中建議能夠遵循這些規範制度,不但能幫助你改善代碼的可讀性,還能讓後期維護變得更簡單。下面的這些案例都是基於PHP規範編寫的,但是對於所有的Web語言都是適用的。

1. 製作表格

在編碼的開始階段,建議你先解決這個問題:如何使用標籤或者空格?通常情況下,行首縮進在大多數編程語言裏並不是必要條件,只是當作二級符號使用。相反,開發人員只是想把程序結構更好的傳達給用戶。尤其需要注意的是,行首縮進是用來展示控制流結構之間的關係,例如:內部/外部的“條件”或“循環”和“代碼”之間的關係。

雖然標籤和空格之間的關係比較巧妙複雜,但是使用四個空格來代替一個標籤是最好的分配辦法。一起來看看實例:當我們使用不同的軟件(比如是在Total Commander裏比較兩個文件)來審查代碼或是比較代碼的時候,標籤和空格看起來明顯不一樣。你只需要試着去縮進兩行代碼,第一行使用標籤,第二行用四個空格,在Notepad++裏看起來是一樣的;但是,將這個文件和它的備份版本(在Total Commander裏)進行比較的話,你就會注意到標籤的長度比四個空格更長(結果就是,獲得更爲嚴重的格式化代碼)。綜上所述,項目裏最好是使用四個空格,而不是標籤。這對將來的維護是有好處的。

2. 類別名

爲了避免類別名的重複出現,同時爲了讓開發者寫出更多獨具一格的類別名,請在類別名前面加上特定的前綴,每個單詞以大寫字母開頭。例如:


3. 變量名

因爲較爲嚴格的數據類型在大部分Web語言裏已經不再使用了,所以爲了方便起見,變量名應該以小寫字母開頭。例如:

  • i: integer
  • f: float / double
  • s: string
  • a: array
  • o: object
  • r: resource
  • b: boolean
  • is: boolean

使用完前綴之後可以接着使用Camel字體。如果你需要宣佈一個私有變量,最好是使用下劃線。


4. 常量名

常量是靜態的變量,這就意味着這些常量值不需要改變。照例可以在常量上使用大寫字母。例如:


5. 功能說明(名稱和格式)

所有的功能名稱都應該以小寫字母開頭,每個單詞都應該以大寫字母開頭。花括號應該在同一行上面(在參數列表後面)。例如:


6. 特殊結構格式

像if/else、for、foreach、while等等之類的特殊結構應該遵循下面的規則:

  • 在結構名稱和緊隨其後的括號之間應該有一個空格。(爲了更好的閱讀)
  • 填寫在括號裏的得出的條件應該用空格分開。
  • 在左括號的後面和右括號的前面不能有空格。
  • 敞開的花括號必須是在同一條線上。
  • 內部條件應該和標籤同步縮進。

7. 數據庫表格名稱

在創建表格的時候,使用合乎邏輯的、易於理解的前綴,同時利用下劃線將單詞分開,不必使用大寫字母。同樣的使用方法也可以用在表格區域。

8. 項目的目錄結構

在團隊開發項目裏,保持文件夾和文檔的結構以一種合乎邏輯的順序排列是特別重要的。千萬不要把所有的東西都毫無組織的放在一個文件夾裏,否則最後得到的只能是一團糟糕的結局。就像這樣:

/root  folder                                                                                                                             /backup                                                                                                                                     /cache                                                                                                                                     /classes                                                                                                                                         /css                                                                                                                                                  /js                                                                                                                                              /media                                                                                                                                     /images                                                                                                                                        /mp3                                                                                                                                           /video

index.php                                                                                                                                   otherFiles.php

結論

事實上,許多開發團隊一直在準備着並在使用自己的編碼規範指示和指導方針,但在任何情況下,上面所提到的編碼規範對所有編程人員都是有用的。好東西大家一起分享。 (編譯/薛樑  校審/付江)

發佈了74 篇原創文章 · 獲贊 31 · 訪問量 43萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章