Close

Not a member yet? Register now and get started.

lock and key

Sign in to your account.

Account Login

Forgot your password?

檔案名稱規範

1.頁面檔名規範

靜態頁面都是統一放在專案目錄底下,那要怎樣跟工程師來溝通檔案的歸類及檔名呢?所以在頁面檔名上,我們有一套命名的規則。命名規則分為四個部份:目錄名稱-主要名稱_屬性名稱(備註).副檔名

  • 最前面第一部份是目錄名稱,用-串接,如果檔案是在根目錄,這個部份可以省略。
  • 第二部份是檔案的主要名稱或動作名稱 (index、list、add、upd、del)。
  • 第三部份為檔案的屬性名稱 (frm、ok、success、failure)。
  • 第四部份為備註用名稱,用來暗示同一支程式,但因應狀況而有不同表現之用,所以實際動態程式的檔名不會包含這部份。

除了第一部份以外,其他都用_串接。第五部份是副檔名一律用.html。而在實務操作上,若目錄名稱要以真正的目錄來呈現也是可以的,這樣在設計或套版時就要多注意相對路徑上的差異及替換,只要在專案一開始溝通好規則,並全部採用一致的設計風格即可。

2.圖片檔名規範

除了頁面檔名有規範外,圖檔我們也整理了一套命名規則:類別-區塊名-識別(編號)-版本.副檔名。類別是指這張圖是bg背景圖、icon、btn…等,區塊名則是搭配CSS Layout所命名的區塊名稱,識別則是指這張圖代表的意義、功能、header、content、footer這些,版本則以v1、v2…以此類推。如果是搭配JS模組的圖,則前面還會再加上JS模組的名稱。
圖檔有一個命名規範有幾個好處:

  1. 檔案以名稱排序的話,這樣同一類別的圖檔會聚集在一起,這樣比較好找檔案。
  2. 搭配CSS Layout的命名方式,CSS會變得更容易理解及維護。
  3. 利於SEO的優化。

3.腳本檔名規範

目前腳本我們大致上是以jQuery函式庫為大宗,命名規則為:jquery.套件名.min.副檔名。盡量都用小寫,並以JSMin工具壓縮過(JSMin前最好先以JSLint驗證檢查一下腳本語法,以確保min後語法不會出狀況)。

Leave a Reply

*