今天要来说说编码规范了,好的编码习惯让我们事半功倍,而坏的习惯就是留给自己,也是留给接手人一推的黑人问号。我在前面的小节的有用到的例子代码就不遵守规范了,变量名称、函数名称的胡乱定义,换行使用也是不规范。
编码规范的好处:
1、对团队开发成员的基本要求。
2、开发人员可以了解任何代码,理清程序的状态。
3、提高程序的可读性,有利于相关设计人员交流,提高软件质量。
4、防止新接触php的人自创风格并养成终生的习惯。
5、有助于程序的维护,降低软件成本。
6、有利于团队管理,实现团队资源的可重复使用。
一、书写规则
1、缩进
使用制表符<tab>键缩进,缩进单位为4个空格左右。
2、大括号
a、将大括号放置到关键字下方,同列
if ($exp)
{
…
}
b、首括号与关键字同行,尾括号和关键字同列
if ($exp){
…
}
3、关键字、小括号、函数、运算符
a、不要把小括号和关键字紧贴在一起,要用空格隔开它们。如if空格($exp)
b、小括号和函数要紧贴在一起。以便区分关键字和函数。如round($num);
c、运算符与两边的变量或者表达式要有一个空格(字符连接运算符“.”除外)。如:
while ($bo == true){ //$bo 和 ==,true 和 == 之间有个空格
…
}
d、当代码段较大时,段上、段下应加入空白行,两个代码段之间只用一个空行,禁止使用多行。
e、尽量不要在return返回语句中使用小括号。
书写规则在一些IDE会自动帮忙排版。
二、命名规则
变量的名称应该能够让代码阅读者容易的知道这些代码的作用,而模棱两可的名字会让阅读者不知所云或者错误错误理解。
1、类命名
a、使用大写字母做为词的分隔,其他字母均使用小写
b、名字的首字母使用大写
c、不要使用下划线(“_”)开头
如:Name、StudentName
2、类的属性命名
a、属性命名应该以字符“m”为前缀
b、前缀“m”后的采用和类命名一样的规则
c、“m”总是在名字的开头起装饰作用,就像以“r”开头的名字表示引用变量一样
如:mName、mValue、mStuName
3、方法命名
方法的作用是执行一个动作,达到一个目的。所以方法的名称应该说明方法是做什么的。一般方法的前缀和后缀有一定的规律。例如:Is(判断)、Get(得到)、Set(设置)。方法的命名规范和类命名是一样的。
例如:
class Student
{
$mName = “Jack”; //名字
$mSex = “男”; //性别
//获得某信息
function GetName()
{
…
}
}
4、方法中的参数命名
a、第一个字符使用小写字母
b、在首字母后的所有字符按照类命名规范首字符大写。如:function GetName($firstName) { … }
5、变量命名
a、所有字母都使用小写
b、使用下划线“_”作为每个单词的分界
如:$txt_name、$chk_hobby
6、引用变量和引用函数命名
引用变量命名要带有“r”前缀。如:function SetExam(&$rExam){ … }、function &rGetExam(){ … }
7、全局变量
全局变量应该带有“g”的前缀。如:global $gTest=”123”、global $g=1
8、常量和全局常量
常量和全局常量,应该全部使用大写字母,单词之间用下划线“_”分开。如:
define(‘DEFAULT_NUM_AVG’,60);
9、静态变量
静态变量应该带有“s”的前缀。如:static $sState=1;
10、函数命名
函数名中的所有字母都使用小写字母,多个单词之间使用下划线“_”来分割。如:function good_ideail(){ … }
一星期小结
这一星期我们主要学习了php的基础知识,包括数据类型,常量,变量,运算符,表达式,函数等的学习,介绍了数据的转换,系统预定义变量,变量,运算符的优先级,函数的使用。最后是php的编码规范。