前端項目可維護性原則

Table of Contents generated with DocToc

• 項目可維護性原則
  
  
  • 1、文件即模塊
  • 2、能夠顯示聲明、顯示統一的地方不要作各類兼容
  • 3、先全局，後局部

1、文件即模塊

歸入模塊化的資源包括：

• 後端模板
• js
• 前端 js 模板
• css

模塊 ID 即文件被引用時的靜態地址：

• 後端模板即 @include 的路徑
• js 中指即 requirejs 打包後獲得的 define 名稱
• js 模板與 js 同樣
• css 中即 @import 的路徑

修改任何模塊要全局查找，要處理全部引入了該模塊的代碼

2、能夠顯示聲明、顯示統一的地方不要作各類兼容

好比能夠規定在 API 使用 page_size 就不要在 JS 中兼容去讓 API 混亂使用多種命名。

3、先全局，後局部

不要爲了局部性能優化，下降可維護性

好比在多個 js 中使用統一的實例化類名稱，方便批量查找（但若是要靠譜地進行依賴搜索，必須使用模塊 ID 來作全局搜索）

obj.pagerView = new ns.views.Pager();

全局搜索 obj.pagerView 時，很快定位其餘文件相同邏輯代碼。

不單單 js 要這樣，css 中的選擇器、html 裏的屬性名等都要如此。

更多：https://github.com/Black-Mirror/FrontEnd-Standard