給樣式取名大概是每個人都遇過的困擾,尤其想取一個「有意義」的名字,往往比寫樣式本身更耗神。回頭整理先前那篇樣式命名規則,再結合這段時間實際使用下暴露出來的問題,我重新梳理了一套更貼近實戰的方案。
最常見的坑,是名稱會隨狀態改變而失去意義。典型例子就是用於佈局的類名,比如 left、right——當左欄不再是左欄,這個名字就變成了廢話,這與我們一直強調的「命名要有意義」完全背道而馳。那用序號呢?序號的問題更明顯。
有很長一段時間我都被一個問題困擾:同一個頁面裡,同一模塊出現了一次以上,細節卻各不相同,後出現的那個該叫什麼?難道 one、two 就不算序號了嗎?老實說,我們真正要規避的情況只有一個——當表現(狀態)改變時,對應的類名不能失去意義。
所謂「狀態改變」,可以拆成三種情形:
red、font14,那麼定義一改,名稱立刻名不符實,對後續維護的傷害相當大。現實專案裡,這幾種情況往往是混雜出現的。廢話不多說,回到規則本身。
[ 模塊前綴 ] _ 類型 _ ( 作用 / 狀態 )n _ [ 位置 n ]
圖例說明:
( 必選 ):必須存在。[ 可選 ]:可依需要選用。/:多選一。n:可出現多個。.class)可重用、對象(#id)唯一,id 請避開保留字。模塊前綴:彈出 pop、公共 global/gb、標題 title/tit、提示 hint、菜單 menu、信息 info、預覽 pvw、Tips tips、導航 nav
類型:按鈕 bt、文本 tx、段落 p、圖標 icon、輸入框 input、顏色 color/c、背景 bg、邊框 bor
作用:設置 set、添加 add、刪除 del、操作 op、密碼 pw、導入 inc
狀態:成功 suc、失敗 lost、透明 tran
位置:公共 gb、邊框 bor、段落 p、彈出 pop、標題 title/tit、菜單 menu、內容 cont、導航 nav
| 中文解釋 | 命名 | 中文解釋 | 命名 |
|---|---|---|---|
| 文本輸入框 | .input_tx | 段落文本顏色 | .tx_c_p |
| 密碼輸入框 | .input_pw | 相冊彈出的設置層 | .pop_set_photo |
| 登錄密碼輸入框 | .input_pw_login | 日誌設置成功提示 | .hint_suc_blogset |
| 文本顏色 | .tx_c | 公共提示 | .hint_gb |
input。input_tx。input_search_index。這套規則未必能覆蓋所有情況,但解決七到八成的命名困惑應該沒問題。如果再配合模塊化的思維來規劃,真正需要定義的名稱其實並不多。比如 hint_tx 表示提示模塊裡的文字定義,hint_tx_hint 表示提示中需要強調的文字——至於是換色還是加粗,就交給具體的提示模塊去決定了。