前言
命名本身技術含量不高,卻直接影響程式碼的可讀性。無論是個人維護,還是團隊協作與後續接手,一套一致的命名約定都能省下大量理解成本。以下整理基本規則與三種常見命名法。
匈牙利命名法是程式設計中的一套變數命名規則,可再細分為系統匈牙利命名法與匈牙利應用命名法。它具備語言獨立性,最早在 BCPL 語言中被大量使用。
由於 BCPL 只有「機器字」一種資料型別,語言本身無法幫助工程師記住變數型別,因此匈牙利命名法用明確的前綴來解決這個問題:變數名以一或多個小寫字母開頭,用來提示型別與用途,緊接著才是工程師自取的 descriptive 名稱,其首字母大寫以便與前綴區隔。
語法
變數名 = 類型 + 對象描述
實作方式是加上小寫前綴標示型別,後面接一或多個描述用途的單字;若是 jQuery 物件,則以 $ 作為前綴。
提示:JavaScript 變數表面上沒有型別,但內部仍會賦予對應型別。匈牙利命名法由一位微軟工程師提出,多數 C、C++ 專案都採用此風格。
型別與前綴對照
array 陣列 → a;boolean 布林值 → b;float 浮點數 → l;function 函式 → fn;int 整數 → i;object 物件 → o;regular 正則 → r;string 字串 → s。
示例
var aName = [1, 2, 3];
var oBtn = document.getElementById('btn');
function fnName(){};
var iCount = 0;
var sName = "zhuyujia";
當變數或函式名由兩個以上單字組成時,用大小寫混排來提升可讀性,就是駝峰式命名法。這個名稱源自 Perl 社群普遍使用的大小寫混合格式,因《Programming Perl》封面是一隻駱駝而得名。
語法:第一個單字以小寫字母起始,後續所有單字首字母大寫,整體看起來像駱駝駝峰般起伏。
示例
var myName = "zhuyujia";
var formSubmit = document.getElementById("submit");
function timeCount(){}
又稱巴斯卡命名法,是程式撰寫時的一套命名慣例,同樣用於增加識別性與可讀性。
語法:與駝峰命名法類似,差別在於第一個單字的首字母也必須大寫,例如 FirstName、LastName。也因為每個單字首字母皆大寫,它被稱為「大駝峰式命名法」(Upper Camel Case),算是駝峰命名法的子集。
示例
var MyName = "zhuyujia";
var FormSubmit = document.getElementById("submit");
function TimeCount(){}
三種命名法都只是慣例,沒有絕對強制,重點是「團隊選定一種之後保持一致」。實務上常見的組合是:變數與函式用駝峰、類別與建構函式用帕斯卡、常數全大寫加底線,再視需要搭配型別前綴。