拉齐奥中文网微博:命名規范

0809雷吉纳拉齐奥 www.kkdsig.com.cn 本命名規范適應于:數據庫命名、C/C++、python、Java、Javascript、Swift、CSS等
1.必須使用英文單詞或者常用的縮寫命名,不允許使用漢字拼音?!境S盟跣疵俺S糜⑽牡ゴ仕跣幢懟薄?br/>示例:name(合格)addr(合格)mingzi(不合格)


2.長度優先級:常見縮寫 >短單詞 >截取單詞前4-5個字母(如意義不明或沖突,增加字母數)
示例:addr >name >soft(ware)


3.數據庫、表、字段名稱都使用小寫字母,多個單詞之間使用_下劃線連接。
示例:name_first


4.單詞選取優先級: 行業匹配 >意義精確 >意義準確 >多詞連接
示例:salary >wage >money >salary_dollar


5.風格:整個系統命名一致,一個詞只能表達一個含義。單詞不要無時態。
示例:is_delete(合格)is_deleted(不合格)is_run(合格)is_running(不合格)


6.對當前字段的描述,不需要表名前綴,而對其他信息的描述,需要中心詞前綴。
示例:當前表為用戶信息,id (合格) user_id(不合格) type(用戶類型,合格) type_user(不合格) type_school(合格)type(表示學校類型則不合格)


7.有系列命名的單詞,不要用中心詞定義名稱,而是要連接單詞定義,而且中心詞先行,格式為:中心詞_定義詞
示例:中心詞是類型,type(不合格),type_user(合格),type_school(合格)


8.所有表都要有id字段,作為本表的索引,用于排序等,也作為其他表對本表的外鍵關聯。規范設置主鍵和外鍵。
示例:id_user--->id 


9.成組命名,中心詞也是先行,名稱要配套,不要混搭,如set和get配套,alter和query配套?!境<釓浼俺<釓潯懟薄?br/>示例:data_get和data_set一組,data_alter和data_query一組


10.基本思想:短小、含義明確、易擴展、易分組、統一風格。
示例:id name pwd age addr ... 


11.一般情況類名使用駝峰命名法,第一個單詞也需要大寫,如GetList(合格),getList(不合格)。如果與特定開發環境有沖突,采用環境適合的駝峰命名法,而無特定需要的,風格按照此處規定命名。


12.類名的對象名,采用類名的小寫或對應的縮寫小寫命名。


13.靜態全局變量,開頭以g_開頭,而類成員,全部以m_開頭。如果要使用開頭,就使用f_開頭。如g_list表示靜態全局變量,多文件都可以引用。m_list是類內的成員變量。而f_list則只是文件范圍內的全局變量。


14.函數名都使用小寫字母,多個字母用下劃線_隔開。函數名稱意思要明確,不要有模棱兩可的命名函數存在。


15.判斷狀態、是否存在、是否正確類的判斷函數,返回符合或不符合的函數,以is_開始命名函數。

16.返回狀態變量用ret,狀態的詳細信息用msg,結果用result,數據用data。