1. 程式人生 > >web開發之菜鳥的代碼規範

web開發之菜鳥的代碼規範

好的編碼 ray function 指定 參數說明 原則 特殊 第一個 約定

筆者菜鳥裏最不會飛的那個,所以這些基礎的習慣都沒養成,正好抽時間特意做個筆記以方便自己規範代碼, 有興趣的大佬多多指點.

養成好的編碼習慣收益良多, 總結下編碼時應註意的細節《借鑒高程裏代碼約束》,對了默默吐槽下,說是前端不需要英語基礎的那些機構們真的是為了錢失了智;

a .命名約束:匈牙利命名/駝峰命名/帕斯卡命名法

匈牙利命名:此命名方法可細分為系統匈牙利命名法和匈牙利應用命名法。

  -> 語法:變量名 = 類型 + 描述

  ->約定類型:

    a --- array

    o --- object

    s --- string

    l --- float

    fn --- function

    i --- int

    r --- regular

    b --- boolean

駝峰命名(小駝峰命名法):第一個單詞以小寫字母開始,後面的所有單詞的首字母都采用大寫字母;

帕斯卡命名(大駝峰命名法):每一個單字的首字母都大寫;

1.變量命名: 名詞

2.方法命名: 動詞

->常見動詞約定:

  can --- 判斷是否可執行某個動作

  has --- 判斷是否有某個值

  is --- 判斷是否為某個值

  get --- 獲取某個值

  set --- 設置某個值

  load --- 加載一些數據

3.特殊函數/變量非硬性約定命名:

  1): 常量:全部大寫單詞之間用"_"劃分;

  2): 構造函數: 大駝峰命名;

  3): 私有成員(屬性/方法): 以"_"為前綴;

b. 編碼非硬性原則:

1.事件Event對象不傳遞, 如有需要只傳需要的數據即可;

2.應用層邏輯可以不依賴任何行為進行;

3.事件層只處理事件;

4.代碼職責單一 ;

5.尊重對象所有權即只修改自己創建的對象;

6.避免全局變量;

c. 代碼性能

1.避免全局查找與盡量減少查找作用域鏈長度;

2.with,eval,setTimeout第一個參數字符形式,Function 避免使用;

3.循環優化

  ->減值叠代

  ->簡化終止條件

  ->簡化循環體

  ->盡量使用後測試循環即 do-while

4.最小化語句數;

5.對數值操作位運算更快;

6.優化dom操作(這塊有很多東西需要研究一時半會也就不分享了);

d:代碼註釋常用標識符:

1.@author 程序的作者說明

2.@version 源文件的版本說明

3.@param 方法的參數說明

4.@deprecated 不建議的使用方法

5.@return 方法的返回值的說明信息

6.@see 參見,用於指定參考內容

7.@exception 拋出的異常類型

8.@throws 拋出的異常

9.@example 示例代碼

筆記這麽多.慢慢培養了;

web開發之菜鳥的代碼規範