1. 程式人生 > >軟件工程—編碼規範

軟件工程—編碼規範

關系 AS 編碼規範 遇到 模塊 cal 組件 inpu med

WXML編碼規範總結

1、 縮進

在有縮進的地方統一采用4個空格,不采納8個空格或者2個空格或者Tab鍵,最不建議采用Tab鍵,它會在不同的環境下顯示不同的長度。

例:

技術分享圖片

2、 行寬

采用每行不超過100個字符為標準,超過100個字符顯得代碼行寬過長,影響閱讀。

例:

技術分享圖片

3、 分行

不采用多條語句同時放置在同一行上,即使該行原本的語句較短,也只能讓其獨占一行,每條語句都只占一行,不允許一行多條代碼的出現。

例:

技術分享圖片

4、 容器的使用

對一個模塊的內容,用一個容器進行包括,保證代碼的可閱讀性,也能夠使整個布局有清晰的條例結構,以便後續代碼的修改提供了方便。

例:

技術分享圖片

5、 函數的綁定

對於button(按鈕)或者Input(輸入框)等組件,需要綁定對應的函數,以便響應對應的事件,不能使其是一個“紙老虎“。

例:

技術分享圖片

6、 屬性

對每個組件,都有各自的屬性,需要確定其各自的屬性。

例:

技術分享圖片

7、 命名以及大小寫

對每個標簽中對應的屬性都需要小寫,每個屬性值首字母大寫,遇到多個單詞的用“ - ”連接或者每個單詞首字母大寫來區分。也采用Camle方法命名。

例:

技術分享圖片

技術分享圖片

8、 註釋

對每個塊或者容器所實現的功能或界面進行註釋,便於閱讀。

例:

技術分享圖片

WXSS編碼規範總結

1、 縮進與行寬

在有縮進的地方統一采用4個空格,不采納8個空格或者2個空格或者Tab鍵,最不建議采用Tab鍵,它會在不同的環境下顯示不同的長度。行寬采用每行不超過100個字符為標準,超過100個字符顯得代碼行寬過長,影響閱讀。

例:

技術分享圖片

2、{ }的使用

無論是判斷語句,或者循環語句,即使在其作用域內只有一條語句,也使用{ },將所屬的塊涵蓋,“{” 和 “}” 都占用一行,更能夠使代碼的條例清晰,代碼的結果明確和對應的關系直當明了。

例:

技術分享圖片

3、分行

不采用多條語句同時放置在同一行上,即使該行原本的語句較短,也只能讓其獨占一行,每條語句都只占一行,不允許一行多條代碼的出現。

例:

技術分享圖片

4、命名以及大小寫

對每個樣式的命名需要由WXML中的命名來決定。采用Camle和Pascal方法命名。

例:

技術分享圖片

Javascript編碼規範總結

1、 括號

對復雜的條件判定中,需要加上對應的圓括號,使得復雜的條件判定更易閱讀和理解,也能使條件的判斷準確無誤。

例:

技術分享圖片

2、{ }的使用

無論是判斷語句,或者循環語句,即使在其作用域內只有一條語句,也使用{ },將所屬的塊涵蓋,“{” 和 “}” 都占用一行,更能夠使代碼的條例清晰,代碼的結果明確和對應的關系直當明了。

例:

技術分享圖片

3、縮進

在有縮進的地方統一采用4個空格,不采納8個空格或者2個空格或者Tab鍵,最不建議采用Tab鍵,它會在不同的環境下顯示不同的長度。

例:

技術分享圖片

4、 行寬

采用每行不超過100個字符為標準,超過100個字符顯得代碼行寬過長,影響閱讀。

例:

技術分享圖片

5、 分行

不采用多條語句同時放置在同一行上,即使該行原本的語句較短,也只能讓其獨占一行,每條語句都只占一行,不允許一行多條代碼的出現。

例:

技術分享圖片

6、 函數的編寫格式及變量修改與訪問

函數由function 函數名(參數){ }的格式進行編寫,在page()中使用函數名:function(){ }的格式進行編寫,在page()中修改data中的值時,需采用this.setData({})進行修改,訪問時使用this.data.變量名進行訪問。

例:

技術分享圖片

7、 空格

對每個二元運算符或者第一個花括號前添加上空格,是代碼更具有閱讀性。

例:

技術分享圖片

技術分享圖片

8、 命名以及大小寫

對每個變量采用唯一化的命名方式,采用Camle和Pascal方法命名。讓變量具有唯一性,明白變量代表的含義,也便於代碼的復審和修改。

例:

技術分享圖片

9、 註釋以及條件判斷

對每個塊或者函數所實現的具體功能進行註釋,便於理解函數的具體作用。在條件判斷中使用“===”進行判斷,只有類型以及值都相等時判斷為真。

例:

技術分享圖片

技術分享圖片

軟件工程—編碼規範