4.1 命名规范
制定统一的命名规范对于项目开发来说非常重要,不但可以养成程序员一个良好的开发习惯,还能增加程序的可读性、可移植性和可重用性,还能很好的提高项目开发的效率。
4.1.1 变量命名
变量命名分为普通变量、静态变量、局部变量、全局变量、Session变量等方面的命名规则。
4.1.1.1 普通变量
普通变量命名遵循以下规则:
a. 所有字母都使用小写;
b. 对于一个变量使用多个单词的,使用’_’作为每个词的间隔。
例如:$base_dir、$red_rose_price等
4.1.1.2 静态变量
静态变量命名遵循以下规则:
a. 静态变量使用小写的s_开头;
b. 静态变量所有字母都使用小写;
c. 多个单词组成的变量名使用’_’作为每个词的间隔。
例子:$s_base_dir、$s_red_rose_prise等。
4.1.1.3 局部变量
局部变量命名遵循以下规则:
a. 所有字母使用小写;
b. 变量使用’_’开头;
c. 多个单词组成的局部变量名使用’_’作为每个词间的间隔。
例子:$_base_dir、$_red_rose_price等。
4.1.1.4 全局变量
全局变量应该带前缀’g’,知道一个变量的作用域是非常重要的。
例如
global $gLOG_LEVEL;
global $gLOG_PATH;
4.1.1.5 全局常量
全局变量命名遵循以下规则:
a. 所有字母使用大写
b. 全局变量多个单词间使用’_’作为间隔。
例子:$BASE_DIR、$RED_ROSE_PRICE等。
4.1.1.6 session变量
session变量命名遵循以下规则:
a. 所有字母使用大写;
b. session变量名使用’S_’开头;
c. 多个单词间使用’_’间隔。
例子:$S_BASE_DIR、$S_RED_ROSE_PRICE等。
4.1.2 类
php中类命名遵循以下规则:
a. 以大写字母开头;
b. 多个单词组成的变量名,单词之间不用间隔,各个单词首字母大写。
例子:class MyClass 或class DbOracle等。
4.1.3 方法或函数
方法或函数命名遵循以下规则:
a. 首字母小写;
b. 多个单词间不使用间隔,除第一个单词外,其他单词首字母大写。
例子:function myFunction ()或function myDbOracle ()等。
4.1.4 缩写词
当变量名或者其他命名中遇到缩写词时,参照具体的命名规则,而不采用缩写词原来的全部大写的方式。
例子:function myPear(不是myPEAR) functio getHtmlSource(不是getHTMLSource)。
4.1.5 数据库表名
数据库表名命名遵循以下规范:
a. 表名均使用小写字母;
b. 对于普通数据表,使用_t结尾;
c. 对于视图,使用_v结尾;
d. 对于多个单词组成的表名,使用_间隔;
例子:user_info_t和book_store_v等
4.1.6 数据库字段
数据库字段命名遵循以下规范:
a. 全部使用小写;
b. 多个单词间使用_间隔。
例子:user_name、rose_price等。
4.2 书写规则
书写规则是指在编写php程序时,代码书写的规则,包括缩进、结构控制等方面规范:
4.2.1 代码缩进
在书写代码的时候,必须注意代码的缩进规则,我们规定代码缩进规则如下:
a. 使用4个空格作为缩进,而不使用tab缩进(对于ultraedit,可以进行预先设置)
例子:
for ( $i=0;$i<$count;$i++ )
{
echo “test”;
}