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

2021-08-27 15:21:53 字數 1537 閱讀 8443

文章作者andrey prikaznov在dzone上分享了關於web開發裡編碼規範的注意事項。編碼時間長的人總會遇到編碼格式標準化的問題,但是不同的專案裡需要使用不同的規則和風格來解決問題,甚至有的時候林林總總的繁雜事情會讓人頭腦發漲,那為什麼不考慮一下標準化編碼呢?換句話說,編碼規範是一套規章制度:用來為某一特定的程式語言的指令碼語言推薦程式設計風格、方法和實踐。這些規範覆蓋方方面面,包括注釋、資料夾、檔案組織、行首縮排、書面宣告、空格、命名規格、程式設計實踐和原則、構建最佳實踐等等。(以下是編譯內容)

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

1. 製作**

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

2. 類別名

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

3. 變數名

因為較為嚴格的資料型別在大部分web語言裡已經不再使用了,所以為了方便起見,變數名應該以小寫字母開頭。例如:

使用完字首之後可以接著使用camel字型。如果你需要宣布乙個私有變數,最好是使用下劃線。

4. 常量名

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

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

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

6. 特殊結構格式

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

7. 資料庫**名稱

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

8. 專案的目錄結構

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

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

index.php otherfiles.php

結論

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

渣漿幫浦磨損的危害,不可小覷

不可否認,渣漿幫浦的運用範圍真的非常廣,在交通運輸 水利 煤炭 電力 冶金 等重要基礎建設行業都有它的身影。隨著使用久了會出現磨損,特別是在輸送泥沙 灰渣 精礦等固體混合物的過程之中,過流部件磨損程度更加嚴重,如果磨損嚴重的話會在工作中產生一些難題,如果過流部分的零部件磨損問題嚴重,會存在一些問題。...

web前端編碼規範

web前端編碼規範 本文摘至bootstrap中文網中bootstrap編碼規範中常用部分,詳細請檢視bootstrap編碼規範 1.html 2.css 相關的屬性宣告應當歸為一組,並按照下面的順序排列 positioning box model typographic visual 單行規則宣告...

web前端編碼規範

最佳原則不管是個人編碼規範還是團隊編碼規範,一旦規範制定完畢就應該堅持使用,保持前後規範一致。筆記通過markdown寫成,對應的github位址為 專案名稱,目錄名稱,一律採用小寫方式,以下劃線分割。例如 my project name 常見命名推薦 img js css src dep 縮排使用...