在開發工作中,我曾與不太按規範寫程式的同事合作過,那段經驗實在很難用「愉快」來形容。寫下這篇文章,除了分享一點心得,更希望對未來的合作伙伴能有些參考價值。以下條目多半是針對實際遇到的編碼習慣而整理,業界其他約定俗成的規範就不再贅述;若有不嚴謹之處,也歡迎前輩指正。
大型 JavaScript 專案在發布前通常會做壓縮,例如使用 Google Closure Compiler Service。新版 jQuery 便改用這個工具,它會移除註解、去掉所有空白與換行,甚至把冗長的變數名稱替換成短而無意義的名字。這麼做可以加快檔案下載、減少流量,對程式碼保護也有一定程度的幫助——壓縮後的程式即使被還原,也不容易一眼讀懂。
想讓程式碼正確通過壓縮,最基本的要求是每個語句都以分號正常結束、大括號嚴格閉合,其餘則要看壓縮工具的要求。如果一開始就沒照標準寫,等壓縮出錯才回頭找問題,那只是在浪費時間。

較完善的開發工具(如 Aptana Studio)都有程式碼自動格式化功能,可以統一換行、縮排與空格。你可以設定自己偏好的風格,例如左大括號是否另起一行。
達到這個要求的好處是:團隊成員可以拿你的程式碼副本,用 IDE 一鍵轉成自己熟悉的樣式來閱讀。他需要讀你的程式,通常是因為你寫的是通用方法,其他模組也要用;直接讀原始碼能最深入了解呼叫方式與實作細節,這是簡單的 API 文件無法取代的。

這是最基本的一項。完整的註解能讓呼叫處顯示參數提示,也能透過文件工具(例如 jsdoc-toolkit)產出 HTML 或其他格式的開發文件。如果你產出的是開放平台的 API,那麼你的文件是給所有開發者看的。
此外,完整的參數描述也方便團隊成員理解你的實作,更方便日後維護——再大的專案,隔了很久回來改東西,也不至於連自己當初寫了什麼都忘光。

好的命名能提升可讀性。大專案裡每個人的程式碼量都不小,規範命名不只是為了別人,也是為了自己:日後系統升級或新增功能時,回頭看自己的程式碼會輕鬆得多。如果最後發現連自己都看不懂當初寫了什麼,那真是天大的笑話。
有意義的同時也要盡量標準。例如 var me = this 或許不如 var self = this,因為 self 在 Python 中的語意正是其他語言的 this。再看這組對比,加上 s 顯然更科學,能一眼看出這個變數存的是複數、可能是陣列:
var li = document.getElementsByTagName('li'); // 不建議
var lis = document.getElementsByTagName('li'); // 建議

JavaScript 作為動態腳本語言,靈活既是優點也是缺點。不同程度開發者實作同一功能時,寫法差異可能極大。無論如何,規範編碼、少搞怪、不要把簡單問題複雜化、不違反可讀性原則,才是該走的路。
例如這句:
typeof(b) == 'string' && alert(b)
應該改寫為:
if (typeof(b) == 'string') alert(b);
前者利用了 && 的短路解析機制:左式為 false 就不再執行右式。條件少時還好,一旦條件多、語句長,可讀性就非常糟。
再看:
+function(a){ var p = a; }('a'); // 不建議
(function(a){ var p = a; })('a'); // 建議
前面的 + 與包住 function 的括號作用相同,都是為了運算優先序;但後者是常見且容易看懂的防止全域污染寫法,許多流行框架都採用這種形式。
還有一個降低可讀性的例子:
// 不建議:多層三元運算子嵌套
function getPostionTxt(type) {
return type == 2 ? "野外" : (type == 3 ? "商城" : (type == 4 ? "副本" : null));
}
// 建議:查表
function getPostionTxt(type) {
var typeData = { "2": "野外", "3": "商城", "4": "副本" };
return typeData[type] || null;
}
如果 type 是從 0 開始連續的整數,直接用陣列更簡單。看到前面那種多層三元運算式嵌套,頭不暈嗎?
語句中不應出現中文,這我想大多數人都知道。這樣做雖然不影響程式執行,卻顯然背離業界標準,而我們畢竟不是在用「易語言」開發。這條我原本不想拿出來講,但確實遇過有人這麼寫。若真的英文不好,至少可以用拼音,或者借助翻譯工具。以下寫法出現在教學場合還可以理解,放進專案就不行:
this.user['名字'] = '張三';
this.user.名字 = '張三';
參數數量固定的函數,內部不該用 arguments 取值。否則別人看到你的方法定義時,無法一眼判斷它接受哪些參數、有幾個。例如:
// 不建議
var $ = function () { return document.getElementById(arguments[0]); };
// 建議
var $ = function (elemID) { return document.getElementById(elemID); };
動態綁定(addEventListener 或 jQuery 的 bind)能讓 XHTML 更乾淨,這我清楚。但一般情況下我仍建議把事件直接寫在 DOM 節點上,因為查看原始碼時就能立刻知道哪個元素綁了什麼方法,維護起來更直覺——你很容易看出某個按鈕或連結被點擊時呼叫了哪段腳本。

不要過度依賴 DOM 的內容特徵來決定要跑哪段腳本,而應該定義不同功能的方法,再由 DOM 去呼叫。這樣無論元素是按鈕還是連結,呼叫方式都一致。以下寫法問題很明顯:
function myBtnClick(obj) {
if (/確定/.test(obj.innerHTML)) alert('OK');
else if (/取消/.test(obj.innerHTML)) alert('Cancel');
else alert('Other');
}
同一個函數裡處理了兩件事,本該拆成兩個函數。而且一旦把連結換成 <input type="button" value="確定" />,obj.innerHTML 就會失效(此時應取 obj.value);若再把按鈕文字由中文改成英文,同樣會壞掉。問題太多,不值得。
JavaScript 是弱型別語言,有些人寫回傳值時就顯得隨便。我認為應該像強型別語言那樣謹慎:
// 不建議:字串函數卻回傳布林值
function getUserName(userID) {
if (data[userID]) return data[userID];
else return false;
}
// 建議
function getUserName(userID) {
if (data[userID]) return data[userID];
else return "";
}
這個方法若用 C# 定義,我們知道它準備回傳字串,因此找不到資料時就該回傳空字串,而不是布林值或其他不搭的型別。這不影響後續呼叫,因為空字串在邏輯判斷中被視為「非」,效果等同 false——除非對方用全等 === 或 typeof 來判斷。
使用標準有好處,那為什麼還有人不用?我想多半是懶或習慣。也有人說少寫引號可以減少檔案體積,這有道理但不是重點。對伺服器回傳的 JSON 而言,標準結構能用 Firefox 的 JSONView 外掛像檢視 XML 那樣以樹狀展開;若你用 jQuery 開發,1.4 之後對 JSON 格式的要求更高,細節可查閱更新文件。總之:
{name:"Tom"} // 不建議
{'name':'Tom'} // 不建議
{"name":"Tom"} // 建議

程式碼調整或重構之後,不再使用的部分應及時刪除;若認為還有參考價值,可以剪貼到暫存檔案。留在專案裡不只增加檔案體積,也會干擾其他成員甚至自己,久了連這方法當初是幹什麼的、有沒被呼叫過都搞不清楚。若暫時要保留,可用 @deprecated 註解標示為不建議使用。
大型專案通常會有部分成員負責通用方法,其他人則要熟悉這些方法,需要時直接呼叫。有些人喜歡「單幹」,連通用方法的文件都不看,在自己模組裡又寫了一遍,這不但製造多餘程式碼,也拖累團隊效率,是不太重視團隊合作的表現,屬於重複造輪子的悲劇。
例如 Common.js 已定義 function $(elemID){ return document.getElementById(elemID); },就不該在 Mail.js 再宣告一次;越複雜的方法越該如此。
當多個方法都能達成同類功能時,要依情境挑最合適的那個。以 jQuery 的兩個 AJAX 方法為例:若確定伺服器回傳 JSON,直接用 $.getJSON,而不是用 $.get 取字串再 eval 轉物件;若因資料量大而必須用 $.post,也應該明確設定 dataType。使用 $.getJSON 時,看程式碼就知道這次請求要的是 JSON。
另外提醒:jQuery 1.4 之後,若伺服器有設定輸出的 ContentType(例如 ASP.NET 的 Response.ContentType = "application/json"),$.get 與 $.getJSON 的效果就没有差別了。
曾看過有人用 DIV 存 JSON 資料以備稍後使用:
<div id="json">{ "name":"Tom" }</div>
這個 DIV 顯然不是用來顯示的。若真要達到「用 HTML 檔做資料快取」的效果,至少該改用隱藏欄位:
<input type="hidden" value='{ "name":"Tom" }' />
其實也可以直接掛在 window 上。例如在 AJAX 請求頁輸出:
<script>window.userData = { "name":"Tom" };</script>
這樣在回呼函數中執行完 $("#MyDiv").html(data) 之後,window 上就有這個變數可用,不必再 eval 一次 innerHTML。要注意的是,放在 window 上的大量資料不會自動消失,得等瀏覽器更新或重啟,不用時應手動清除以免增加記憶體負擔。
程式碼最優化該是每個開發者持續追求的目標。寫程式時不要急著把功能做出來,先想清楚怎麼寫、執行效率如何。
舉例:假設有 function $(elemID){ return document.getElementById(elemID); },有人可能寫成:
$("MyDiv").parentNode.removeChild($("MyDiv"));
這裡做了兩次 DOM 查詢。改寫成下面這樣更好:
var myDiv = $("MyDiv");
myDiv.parentNode.removeChild(myDiv);
getElementById 的查詢算快,若換成 getElementsByTagName 就更該注重這類優化。jQuery 開發團隊也曾提醒過類似問題。
優化技巧需要長期累積。曾有朋友說他寫後台程式從來不考慮優化,因為用的是四核伺服器——我覺得這想法很危險。
這項能力對每個開發者都很關鍵,也是決定水準高低的重要因素之一。能把需求細化、抽象出合適的類別,再條理分明地組織程式碼,讓結構清楚、可讀性高、易於維護,而不流於程序化與雜亂無章,才算得上優秀。
以上 17 條,多數不是什麼高深技術,而是把小事情做對的紀律。規範的真正價值在於降低協作成本:當每個人的程式碼都能被壓縮、能被格式化、能被讀懂,團隊的速度才會真正快起來。