程式變數命名方式

寫程式第一件事，就是命名，不管是變數，檔名，函數...等，有一堆等著你命名，對於非英語系國家的軟體工程師就更辛苦了。

這裡整理一些命名規則，方便未來使用，以免每次寫程式第一步就卡住。

駝峰式命名法 camel case

駝峰式命名法就是指變數第一個字母會小寫，而變數第二個以上的單字，其第一個字母為大為，例如： 「getData」，「removeProduct」。

constant 變數命名方式

實體目錄開頭使用 PATH

• 檔案根目錄 PATH_ROOT

網路目錄開頭使用 URL

• URL 根目錄 URL_ROOT

絕對路徑 URL_ABS

• URL_ABS_ROOT

透過 function 取得資料

取得資料代表的英文單字有 get、fetch、seize

• 透過網路方式，使用 fetch 這個字母，例如： fetchProductHtml，fetchInfo
• 一般取得 Object 中的 property ，使用 get 這個字母， 例如： getProductId， getTitle

建立新資料

可以使用的英字單字有： add、create、insert。

• insert : 新增一筆資料進 database
• insertOrder
• insertItem
• add : 新增一筆資料進 object, array
• addItem
• addProduct
• create : 建立連線，檔案
• createClient
• createFile

刪除資料

刪除這個 method 幾乎每個 class 都會有，可用來表達這件事的英文有 「delete」，「remove」。

• delete ：刪除整個陣列。
• remove ： 使用 Remove 的時機，我給他下一個定義，也就是當我要移除整個陣列中的一個物件時，我會將這個 method 命名為 Remove。

完成一件事情 complete

從網路上下載一件資料完成。fetchContent -> fetchComplete

Frontend 開發常常會使用一些動畫來導引使用者，例如刪除一個物件時，這個物件會有淡出的效果，慢慢的消失，等到透明度變成 0 % 時，這個物件才會真真的被移除。

這裡可以表達這件事的英文有 complete、finish、done、end。

• complete
• finish
• done
• end : 用在動態效果，如物件移動 (Animation) ， 有 start 才有 end 。

For Loop

一個 for loop 最見常的變數是用 I, j , k ,n ，而這個命名方式雖然常見，但是並不容易看懂，這時可以使用另一種命名方式。

• len: 長度
• index

假設有一個訂單資訊的 for loop，命名如下

• orderLen
• orderIndex
• itemLen
• itemIndex

var orderLen = order.length;
var orderInde, itemLen, itemIndex;
for ( orderIndex = 0 ; orderIndex < orderLen; orderIndex++) {
   itemLen = order[orderIndex]['items'].length;
   for (itemIndex = 0; itemIndex < itemLen; itemIndex++) {
      alert ( order[orderIndex]['items'][itemIndex] );
   }
}