程式变数命名方式

写程式第一件事，就是命名，不管是变数，档名，函数...等，有一堆等著你命名，对於非英语系国家的软体工程师就更辛苦了。

这里整理一些命名规则，方便未来使用，以免每次写程式第一步就卡住。

驼峰式命名法 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] );
   }
}