规则一般都是经过深思熟虑后才出来,所以再项目开发中,都必须按规则办事或编码,如果觉得某项规则有问题,可以提出来讨论是否更换规则,
但更换之前都必须按规则办事,再项目前期规则最好由技术经理或架构师或由研发团队一起讨论,规则其实由点像做架构的感觉,把方方面面都考虑清楚了
有规则不遵守,后期会一塌糊涂!
1、 项目名称
NO | 信息项 | 含义说明 |
1 | 团队名称(缩写) | 某某研发团队(MOUMOU-YANFA-NET) |
2 | 项目名称(缩写) | B2B交易平台(B2B-JIAOYI) |
2、项目版本名称
当项目比较大或分阶段开发时,往往不同阶段会出来不同的版本,或测试组都会要求项目有版本,测试组都以某版本进行测试
版本更新说明较上个版本有增加功能,改进或修复了多少BUG,名称的定义尽量能反映功能数量,bug 数量,当然还需要有文档记录目前版本
改动,比如项目的简称:B2B,目前版本增加了4个功能,40 个bug
则 此版本名称:B2B.4.40
3、代码规范
以下规范,以PHP 为标准
[1]、统一编码,html,js,php文件,数据库统一编码,通用编码utf8,gbk
[2]、PHP 编码通用规范:
(1) 所有嵌入必须以 <?php 为开始,以 ?> 结束,不得以简写形式 <? ?> 出现,即不要使用PHP短标签
(2) 代码缩进一个tab键(4个空格).
if($xxx == 3){
//
}
或者
if ($xxx == 3)
{
}
(3)操作符两端空一格,
$goods = array();
if($num > 6){
}
$num . "hello world";
(4) 基于"if", "else"和"else if"的条件控制里,我们必须用空格间隔开语句和括号,
第一个花括号开始 { 要换行或不换行,与花括号结束 } 对齐; 这个看习惯,不过本人目前
习惯使用第一个 花括号 不换行
if ($xxx == 3) {
//
}
或者
if ($xxx == 3)
{
}
foreach ($i = 1 ; $i <= 3 ; $i++)
{
}
(5)当需要判断的条件很多或代码块很多时可以考虑用if 判断 switch 语句只能是否相等这样的逻辑处理但switch 执行效率比if 高很多,在 switch 语句中应该总是包括 default 控制
switch ($_num) {
case 2:
echo "错误";
break;
case 4:
echo "正确";
break;
default:
break;
}
(6)if 条件中 如果条件时 时数字或字段 跟变量做比较 则数字或字符串必须写再操作符前面
if ("hello" == $hello)
{
}
if (1 == $num)
{
}
(7)所有包含文件一律只能用require和include,包含函数类文件必须用require. 包含样式类(如与显示相关的)文件必须用include,require 和 include 包含文件必须写成以下格式: require'./abc.php'; 和 include'./abc.php'; 不许使用括号()和双引号"" ,当前路径必须以 ./ 开头,总体来说require 的性能高于include 好几倍
(8)PHP引号使用原则,PHP中尽量用单引号,HTML代码全部用双引号,在包含变量的时候,用双引号可以简化操作,复杂的情况下用大括号包起来
PHP引号还有一个用处就是,有的时候需要用php生成文本文件,换行符\n需要用双引号才能好使,单引号则会直接把\n当成字符输出,例子
echo '文件包含成功';
echo "文件包含成功$filename";
echo '文件包含成功'."\n";
(9) 数组取值时尽量用$row['id'],$row['id']的速度是$row[id]的7倍。 $row['key'] 与 $row["key"] 与 $row[key]的差别:
1,$row['key'] 单引号模式被直接解析为$row的值;
2,$row["key"]双引号模式会首先分析"key"字符串内部是否包含 PHP变量,然后再解析为$row的值;
3,$row[key]没有任何引号会先分析局部作用域内有没有key常量定义(即有无define('key','val')),
(10) 注销那些不用的变量尤其是大数组,以便释放内存。
(11) include文件时尽量使用绝对路径,因为它避免了PHP去include_path里查找文件的速度,解析操作系统路径所需的时间会更少,
所以在应该定义根目录的常量ROOT_PATH
(12) 函数代替正则表达式完成相同功能,str_replace函数比preg_replace函数快,但strtr函数的效率是str_replace函数的四倍
(13) 变量使用之前,必须定义,递增一个未预定义的局部变量要比递增一个预定义的局部变量慢9至10倍。
(14) 方法调用看来与类中定义的方法的数量无关,因为我(在测试方法之前和之后都)添加了10个方法,但性能上没有变化。
(15) 递增或递减尽量用++$i或--$i,当执行变量$i的递增或递减时,$i++会比++$i慢一些。这种差异是PHP特有的,并不适用于其他语言,所以请不要修改你的C或Java代码并指望它们能立即变
(16) 循环尽量用foeach,foreach效率更高,尽量用foreach代替while和for循环;
(17) “用i+=1代替i=i+1。符合c/c++的习惯,效率还高”;
(18) 变量用完后,尽量unset()掉,特别是在action 中或大数组
(19) 对用于赋值的条件语句,可改用?:算符
(20) 读取文件时改用get_file_content函数 ,file函数效率低,不过get_file_content,如果需要根据网址读取内容时,往往会错误,反正需要curl 代替
(21) 在循环中判断时,数值判断使用恒等要比等于高效 比如
if($a==$b)$c=$a; //低效
if($a===$b)$c=$a;//高效
(22) 递增一个对象属性(如:$this->prop++)要比递增一个局部变量慢3倍
[1]、 注释规范
[2]、变量规范
[3]、数据库规范
[4]、