命名规范

本命名规范适应于:数据库命名、C/C++、python、Java、Javascript、Swift、CSS等
1.必须使用英文单词或者常用的缩写命名,不允许使用汉字拼音。【常用缩写命名见“常用英文单词缩写表”】
示例: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配套。【常见搭配见“常见搭配表”】
示例: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。