JavaScript 庫開發者應遵循的 11 條鐵律
給庫作者的規範
- 無侵入性:HTML 標記不應包含庫專屬屬性/類別;行為與結構分離。
- 嚴禁修改
Object.prototype:會污染所有物件的 for...in,造成不可預期 Bug。
- 克制擴充內建原型:僅提供必要 Polyfill,並檢查
if (!Array.prototype.xxx)。擴充越少,衝突機率越低。
- 遵循標準:優先實作標準 API(如
Array.prototype.forEach),命名參數、行為與規格一致。
- 緊跟 Mozilla/標準前沿:新語法特性參考 MDN/TC39,命名遵循標準(如
forEach 而非 each)。
- 保持彈性:使用者無需改源碼即可客製化行為(選項、回呼、事件、繼承、組合)。
- 管理記憶體:釋放事件監聽、清理快取、避免閉包洩漏,提供
destroy() 方法。
- 拒絕瀏覽器嗅探:使用特性偵測(Feature Detection),嗅探極易失效。
- 精簡體積:提供模組化建構、Tree-shaking 支援、按需載入,體積越小越好。
- API 可預測:方法名稱語意清晰,參數順序一致,錯誤訊息有幫助。
- 文檔完善:API 文件、遷移指南、範例、TypeScript 定義檔缺一不可。
附則
- 命名空間越淺越好(如
jQuery、_、Vue),避免深層巢狀。
- 記住:你的代碼可能在數百萬頁面執行,每一個 Byte、每一個 Breaking Change 都有放大效應。
copyright ©
萬盛學電腦網 all rights reserved