寫一個給別人用的 JavaScript 函式庫,和寫給自己看的腳本是兩件完全不同的事。以下 eleven 條準則,歸納了讓函式庫能被信任、被長久使用的關鍵。
我的 HTML 標記不該知道你的 JavaScript 存在。不要為了運作而要求使用者改寫標籤結構或插入一堆行內屬性。
這條重要到必須獨立成款。物件是 JavaScript 最根本的構成磚,一旦你在 Object.prototype 上動手腳,for...in 的行為會全面改變,全站的第三方程式碼都可能跟著出錯。絕對不要做。
別誤會——原生物件好用的方法確實不多,偶爾補一兩個情有可原。但富有創造力的開發者往往一補就停不下來。請克制:你擴充得越少,與其他框架撞名的機率就越低。
作為函式庫作者,你定義的就是別人眼中的「JavaScript 該長什麼樣」。設計模式的存在,某種程度反映的是語言能力的不足。另外,JavaScript 與 DOM 規格一直在演進,想「修正」什麼之前,先確認標準裡是不是已經有了;如果決定跟隨標準,就跟到底,別漏掉 forEach 的某個參數。
Mozilla 長期引領 JavaScript 的發展,語言的多數新特性往往先在 Mozilla 系瀏覽器中可用。因此當你要為 Array 加一個走訪方法時,命名成 forEach 會比自創的 each 好得多——即使你其實很想叫它 each。若確實要提供尚不存在的特性,也請緊貼既有慣例。
如果使用者想改進行為而不動到你的原始碼,這件事容易嗎?如果不夠容易,就把它變容易。
記憶體洩漏是函式庫最致命的問題之一,尤其在使用者頁面長時間開啟的情況下。請盡力而為。
瀏覽器廠商會永遠透過增加新特性來競爭,而嗅探一旦開始就容易上癮。請把精力放在功能偵測上,而不是追逐下一篇 hack 文章。
函式庫已經相當成熟,有些甚至跑在主流網站上。但並非每個使用者都有高速網路,因此請控制體積。更好的做法是提供打包頁面,讓使用者依需求自行取用需要的模組。
我應該能猜到你的方法要做什麼。就算猜不到確切名稱,也應該能猜個八九不離十。api 的命名一致性,往往比多寫十頁文件更有價值。
寫文件。麻煩,但絕對必要。你使用的命名空間越多,我就越難記——就像記你的電話號碼一樣。也請記住:可能有數百萬人會執行你的程式碼。