命名一直是讓我頭痛的事,特別是面對一堆長相相似的模組時。折騰久了總得想辦法收斂,以下是我目前仍在驗證的一套規則,歡迎大家一起改進。
第一,命名選詞要避免過度具體描述某一狀態(例如顏色、字級),否則狀態一變,名稱立刻失去意義。
第二,類名由以小寫字母(a-z)開頭的字母、數字(0-9)、底線(_)與連字號(-)組成;ID 名稱則由非數字開頭的小寫字母、數字與底線組成。
[模組前綴|類型|作用]_[名稱]_[狀態|位置]
約定好模組、類型、狀態、位置各自使用的單字或縮寫,保持上述順序,並盡量用兩到三個單字把用途說清楚。
設置 set 成功 suc 提示 hint 操作 op 密碼 pw 菜單 menu 按鈕 bt 文本 tx 顏色 c 背景 bg 邊框 bor 居中 center 圖標 icon 彈出 pop
文本輸入框 .input_tx 密碼輸入框 .input_pw 登錄密碼輸入框 .input_pw_login 日誌設置成功提示 .hint_suc_blogset 相冊彈出的設置層 .pop_set_photo 公共提示 .hint_bg 文本顏色 .c_tx 段落文本顏色 .c_tx_p
這套方案真正的價值不在縮寫本身,而在於「全隊約定同一份詞彙表」。當每個人都用 suc 表示成功、用 hint 表示提示時,看到類名就能大致猜出用途,交接與維護的成本自然下降。