序言

There are only two hard things in Computer Science: cache invalidation and naming things.
-- Phil Karlton

我喬魯諾·喬巴拿有一個(gè)夢(mèng)想，便是要成為程序員巨星。但如果你看過(guò)我寫(xiě)的代碼，便知道我還遠(yuǎn)遠(yuǎn)夠不上“巨星”二字。我的代碼中有許多不一致的命名：

1. 常量的命名時(shí)而是全大寫(xiě)的（如WAIT_CONFIRM），時(shí)而是全小寫(xiě)的；
2. 某個(gè)項(xiàng)目大部分命名用的是camel case（如TaskController），但由于數(shù)據(jù)庫(kù)中的列名用了snake case（如context_id），導(dǎo)致項(xiàng)目中與數(shù)據(jù)庫(kù)列有關(guān)的代碼混用了camel case和snake case（如restricted_hours[new Date(timestamp * 1000).getHours()] = 1;）；
3. 同樣是構(gòu)造復(fù)雜對(duì)象的函數(shù)，它們的前綴可能會(huì)是build、create、make，甚至compute中的任何一個(gè)；
4. 明明是一個(gè)數(shù)組，卻用了單數(shù)的order作為變量名。

之所以如此混亂，正是因?yàn)槲覜](méi)有遵循一套一致的命名規(guī)則。每當(dāng)我在一個(gè)項(xiàng)目中蹦出一些新想法時(shí)，便會(huì)躍躍欲試——不，我真的就用上了。我不曾整理過(guò)自己的命名規(guī)則（天哪我已經(jīng)寫(xiě)了三年的JavaScript了），以至于無(wú)從判斷“新想法”是否真的新——也許它是一個(gè)已經(jīng)被我拋棄的規(guī)則。

為了不再深陷不一致命名的泥潭，我定下了本篇的命名規(guī)則，期望它們?yōu)橐院蟮奈抑更c(diǎn)迷津。

變量名

通用規(guī)則

• 變量名使用camel case的命名風(fēng)格。例如，使用namingConvention，而不是naming_convention；
• 在盡量遵循規(guī)則的基礎(chǔ)上隨機(jī)應(yīng)變。

變量名的單復(fù)數(shù)規(guī)則

• 如果一個(gè)變量存儲(chǔ)的值的類(lèi)型為數(shù)組（即該變量作為Array.isArray方法的參數(shù)時(shí)結(jié)果為真），那么變量的名稱(chēng)就使用復(fù)數(shù)形式。例如，使用fruits = []而不是fruit = []。
• 如果一個(gè)變量存儲(chǔ)的值的類(lèi)型為集合（即Set這個(gè)類(lèi)型），那么變量的名稱(chēng)應(yīng)當(dāng)使用單詞unique為前綴。例如，使用uniqueUserIds而不是userIdSet。

布爾變量的命名規(guī)則

如果一個(gè)變量的值的類(lèi)型為boolean，那么變量的名稱(chēng)應(yīng)當(dāng)以下列單詞為前綴：

• is。當(dāng)變量表達(dá)一個(gè)二元狀態(tài)的時(shí)候，例如isFull、isEmpty。在is后面的應(yīng)當(dāng)是一個(gè)形容詞；
• has。當(dāng)變量表達(dá)歷史上是否發(fā)生過(guò)某個(gè)事件的時(shí)候，例如hasPaid、hasArrived。在has后面的應(yīng)當(dāng)是一個(gè)動(dòng)詞，并且采用過(guò)去分詞；
• can。當(dāng)變量表達(dá)某種權(quán)限的時(shí)候，例如canWrite、canExecute。在can后面的應(yīng)當(dāng)是一個(gè)動(dòng)詞，并且采用現(xiàn)在分詞。

數(shù)值變量的命名規(guī)則

• 如果變量中存儲(chǔ)的是一系列數(shù)字中的最大值，那么變量的名稱(chēng)應(yīng)當(dāng)以max為前綴，例如maxScore。如果是最小值，則是以min為前綴，例如minScore；
• 如果變量中存儲(chǔ)的是一系列數(shù)字的和，那么變量的名稱(chēng)應(yīng)當(dāng)以total為前綴，例如totalIncome；
• 如果變量中存儲(chǔ)的是數(shù)組的長(zhǎng)度，那么變量的名稱(chēng)可以用numberOf為前綴，例如numberOfUsers。

字符串變量的命名規(guī)則

• 如果表達(dá)的是人名、品牌名、公司名、數(shù)據(jù)庫(kù)中的表名，那么變量的名稱(chēng)可以用單詞name結(jié)尾，例如customerName、brandName、companyName；
• 如果表達(dá)的是按鍵或按鈕上刻著的文字、紙質(zhì)表格或電子表單上輸入框左側(cè)的簡(jiǎn)短說(shuō)明，那么變量的名稱(chēng)可以用單詞label結(jié)尾，例如buttonLabel；
• 不允許使用單詞content

函數(shù)名

• 函數(shù)的名稱(chēng)應(yīng)當(dāng)由動(dòng)詞和名詞組成，例如readFile、writeFile；
• 如果函數(shù)的功能是將參數(shù)轉(zhuǎn)換為另一種形式的輸出（比如進(jìn)制轉(zhuǎn)換、幣種轉(zhuǎn)換），那么函數(shù)的名稱(chēng)應(yīng)當(dāng)以單詞to為前綴，例如toDollar、toHexadecimal；
• 如果函數(shù)的功能是檢驗(yàn)參數(shù)并返回一個(gè)布爾值，那么函數(shù)的名稱(chēng)應(yīng)當(dāng)以單詞check為前綴，例如checkIsDirectory、checkIsExecutable；
• 如果函數(shù)的功能是“計(jì)數(shù)”，那么函數(shù)的名稱(chēng)應(yīng)當(dāng)以單詞count為前綴，并且其中被計(jì)數(shù)的對(duì)象應(yīng)當(dāng)為復(fù)數(shù)形式，例如countPaidOrders。

構(gòu)造型函數(shù)的命名規(guī)則

• 如果表達(dá)的是從無(wú)到有地創(chuàng)造一個(gè)對(duì)象，那么函數(shù)名可以用create作為前綴，例如createObject；
• 如果表達(dá)的是將一些輸入原封不動(dòng)地放在一起（可能輸入之間添加了其它東西）創(chuàng)造出一個(gè)對(duì)象，那么函數(shù)名可以用make作為前綴，例如makeFloor。進(jìn)一步地，如果函數(shù)不改變輸入的相對(duì)順序，那么函數(shù)名可以用concat，例如concatString；
• 如果函數(shù)會(huì)將根據(jù)輸入創(chuàng)造出具有不止一個(gè)層級(jí)的對(duì)象，那么函數(shù)名可以用build作為前綴，例如buildBinarySearchTree。

修改型函數(shù)的命名規(guī)則

• 如果函數(shù)負(fù)責(zé)更新數(shù)據(jù)庫(kù)中的記錄，那么函數(shù)名應(yīng)當(dāng)以單詞update為前綴；
• 如果函數(shù)修改的是一些可枚舉的狀態(tài)，那么函數(shù)名應(yīng)當(dāng)以單詞change為前綴。

類(lèi)名

• 類(lèi)的名稱(chēng)應(yīng)當(dāng)采用capital case的命名風(fēng)格，例如DatabaseConnection；
• 類(lèi)的名稱(chēng)應(yīng)當(dāng)以一個(gè)名詞結(jié)尾；
• 如果類(lèi)的存在是為了使用某種設(shè)計(jì)模式，那么類(lèi)名應(yīng)當(dāng)可以反映在設(shè)計(jì)模式中所處的位置，例如在State模式中，代表具體狀態(tài)的類(lèi)的名稱(chēng)可以是InitialState、UnpaidState。

參考資料

The art of naming variables
Google JavaScript Style Guide
Letter case

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論