制定统一的命名规范对于项目开发来说非常重要,不但可以养成程序员一个良好的开发习惯,还能增加程序的可读性、可移植性和可重用性,还能很好的提高项目开发的效率。
一、变量命名
变量命名分为普通变量、静态变量、局部变量、全局变量、Session变量等方面的命名规则。
1,普通变量:
a. 所有字母都使用小写;
b. 对于一个变量使用多个单词的,使用’_'作为每个词的间隔。
例如:$address、$user_name等
2,静态变量
a. 静态变量使用小写的s_开头;
b. 静态变量所有字母都使用小写;
c. 多个单词组成的变量名使用’_'作为每个词的间隔。
例子:$s_base_dir、$s_url等
3,局部变量
a. 所有字母使用小写;
b. 变量使用’_'开头;
c. 多个单词组成的局部变量名使用’_'作为每个词间的间隔。
例子:$_item、$_red_rose_price等。
4,全局变量
a. 全局变量应该带前缀’g';
b. 所有字母使用大写;
c. 多个单词组成的全局变量名使用’_'作为每个词间的间隔。
例如:global $gLOG_LEVEL、global $gLOG_PATH;
5,session变量
a. 所有字母使用大写;
b. session变量名使用’S_’开头;
c. 多个单词间使用’_'间隔。
例子:$S_BASE_DIR、$S_RED_ROSE_PRICE等。
二、类
1,如果实用框架,应跟随框架类名命名规范
2,非框架命名规范如下:
a. 以大写字母开头;
b. 多个单词组成的变量名,单词之间不用间隔,各个单词首字母大写。
三、方法/函数
1, 首字母小写;
2, 多个单词间不使用间隔,除第一个单词外,其他单词首字母大写。
四、缩写词
当变量名或者其他命名中遇到缩写词时,参照具体的命名规则,而不采用缩写词原来的全部大写的方式。
例子:function myPear(不是myPEAR) functio getHtmlSource(不是getHTMLSource)。
五、数据库
1, 表名
a. 表名均使用小写字母;
b. 对于普通数据表,使用_t结尾;
c. 对于视图,使用_v结尾;
d. 对于多个单词组成的表名,使用_间隔;
例子:user_info_t和book_store_v等
2, 数据库字段
a. 全部使用小写;
b. 多个单词间使用_间隔。
例子:user_name、rose_price等。
* 以上命名规则均摘抄自网络,非官方标准,仅用来规范自己!