命名规则

一、变量命名

1、普通变量

• 变量中的所有字母字符均为小写

	//例
	$username = 'Jim Green';
	//反例
	$userNAME = 'Li Lei';

• 变量命中只能出现字母和下划线和必要时的数字（变量中除非十分必要时可出现数字，否则不建议在命名中使用数字）

	 //例
	 $name_wang = 'Mr . wang';
	 $name_zhang= 'Mr . zhang';
	 //反例
	 $name1 = 'Mr . wang';
	 $name2 = 'Mr . zhang';

• 变量以字母开头，不能以下划线和数字开头，也不能以下划线结尾
• 变量中禁止出现拼音和英文单词的组合，更不允许出现汉字，不推荐拼音来命名

	  //例
	  $goods_redwine = '红酒';
	  //反例
	  $goods_hongjiu = '红酒';

• 变量名尽量不使用缩写，或者使用通用的、公认的缩写
• 变量名要达到望文生义的效果

2、常量

• 常量名全部大写，要求语义明确，不局限于变量名称的长度，各单词之间用下划线连接

	define('MESSAGE', 'Welcome to earth !');
	define('FIRST_MESSAGE', 'Hello World !');

• 常量名要达到望文生义的效果
• 常量名中只能出现大写字母和下划线 ，杜绝出现数字
• 下划线只用来作连接作用，不出现在变量名来头和结尾

3、成员变量

• 成员变量名以小写字母开头，成员变量名由多个单词组成时，除第一个单词首字母小写，其他单词首字母大写然后连接（小驼峰命名）
• 杜绝出现除字母之外的其他符号，不推荐在成员变量中使用数字
• 成员变量名要达到望文生义的效果

4、参数名

• 方法函数的参数名以小写字母开头，由多个单词组成时，除第一个单词首字母小写，其他单词首字母大写然后连接（小驼峰命名）
• 杜绝出现除字母之外的其他符号，不推荐在参数名中使用数字
• 参数名要达到望文生义的效果

二、方法函数命名

• 方法函数名以小写字母开头，方法函数名由多个单词组成时，除第一个单词首字母小写，其他单词首字母大写然后连接（小驼峰命名）
• 方法函数名中禁止出现拼音和英文单词的组合，更不允许出现汉字，不推荐拼音来命名
• 杜绝出现除字母之外的其他符号，不推荐在方法函数名中使用数字
• 方法函数名要浅显易懂，达到望文生义的效果

三、类命名

• 类名以大写字母开头，类名由多个单词组成时，各单词首字母大写然后连接（大驼峰命名）
• 类名中禁止出现拼音和英文单词的组合，更不允许出现汉字，不推荐拼音来命名
• 杜绝出现除字母之外的其他符号，不推荐在类名中使用数字
• 类名要浅显易懂，达到望文生义的效果

四、一些命名约定

1、变量名

• bool型的标志或者状态通常在命名中添加 _flag 或 _status 后缀
• 数组使用 _arr 后缀名或者使用 名词复数形式
• 从数据库查询到的数据集合通常使用 moduleName + _list / _data / _arr 约定来命名

2、方法名

• 更新方法使用 update 前缀
• 删除方法使用 remove 或者 delete 前缀
• 插入方法使用 save 或者 insert 前缀
• 获取单个数据方法使用 get 前缀
• 获取多个数据方法使用 list 前缀
• 统计方法使用 count 前缀
• 判断方法使用 is 前缀

3、类名、接口名

• 抽象类使用 Abstract 前缀
• 异常类使用 Exception 后缀
• 测试类使用要 测试类的类名 + Test后缀