PHP团队开发规范 团队开发规范

本文详细介绍了一套严格的PHP代码规范,包括文件结构、缩进、命名约定、注释、空格及空行等细节,旨在提高代码可读性和维护性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

一、基本约定

1、源文件

(1)、纯PHP代码源文件只使用 <?php 标签,省略关闭标签 ?> ;

(2)、源文件中PHP代码的编码格式必须是无BOM的UTF-8格式;

(3)、使用 Unix LF(换行符)作为行结束符;

(4)、一个源文件只做一种类型的声明,即,这个文件专门用来声明Class, 那个文件专门用来设置配置信息,别混在一起写;

2、缩进

使用Tab键来缩进,每个Tab键长度设置为4个空格;

3、行

一行推荐的是最多写120个字符,多于这个字符就应该换行了,一般的编辑器是可以设置的。

4、关键字 和 True/False/Null

PHP的关键字,必须小写,boolean值:true,false,null 也必须小写。

下面是PHP的“关键字”,必须小写:

'__halt_compiler', 'abstract', 'and', 'array', 'as', 'break', 'callable', 'case', 'catch', 'class', 'clone', 'const', 'continue', 'declare', 'default', 'die', 'do', 'echo', 'else', 'elseif', 'empty', 'enddeclare', 'endfor', 'endforeach', 'endif', 'endswitch', 'endwhile', 'eval', 'exit', 'extends', 'final', 'for', 'foreach', 'function', 'global', 'goto', 'if', 'implements', 'include', 'include_once', 'instanceof', 'insteadof', 'interface', 'isset', 'list', 'namespace', 'new', 'or', 'print', 'private', 'protected', 'public', 'require', 'require_once', 'return', 'static', 'switch', 'throw', 'trait', 'try', 'unset', 'use', 'var', 'while', 'xor'

5、命名

(1)、类名 使用大驼峰式(StudlyCaps)写法;

(2)、(类的)方法名 使用小驼峰(cameCase)写法;

(3)、函数名使用 小写字母 + 下划线 写法,如 function http_send_post(); 

(4)、变量名 使用小驼峰写法,如 $userName;

6、代码注释标签

如 函数注释、变量注释等,常用标签有 @package@var@param@return@author@todo@throws

必须遵守 phpDocument 标签规则,不要另外去创造新的标签,更多标签查看 phpDocument官网

7、业务模块

(1)、涉及到多个数据表 更新/添加 操作时,最外层要用事务,保证数据库操作的原子性;

(2)、Model层,只做简单的数据表的查询;

(3)、业务逻辑统一封装到 Logic层;

(4)、控制器只做URL路由,不要当作 业务方法 调用;

(5)、控制器层不能出现SQL操作语句,如 ThinkPHP框架的 where()、order() 等模型方法,

即,控制器中,不要出现类似这样的SQL语句:D('XXX')->where()->order()->limit()->find();  

where()、order()、limit() 等SQL方法只能出现在 Model层、业务层!

二、代码样式风格

1、命名空间(Namespace) 和 导入(Use)声明

先简单文字描述下:

  1. 命名空间(namespace)的声明后面必须有一行空行;
  2. 所有的导入(use)声明必须放在命名空间(namespace)声明的下面;
  3. 一句声明中,必须只有一个导入(use)关键字;
  4. 在导入(use)声明代码块后面必须有一行空行;

用代码来说明下:

1
2
3
4
5
6
<?php
namespace  Lib\Databases;  // 下面必须空格一行
 
class  Mysql {
 
}

namespace下空一行,才能使用use,再空一行,才能声明class

1
2
3
4
5
6
7
8
9
10
<?php
namespace  Lib\Databases;  // 下面必须空格一行
 
use  FooInterface;  // use 必须在namespace 后面声明
use  BarClass  as  Bar;
use  OtherVendor\OtherPackage\BazClass;  // 下面必须空格一行
 
class  Mysql {
 
}

2、类(class),属性(property)和方法(method)

(1)、继承(extends) 和实现(implement) 必须和 class name 写在一行。

1
2
3
4
5
6
<?php
namespace  Lib\Databaes;
 
class  Mysql  extends  ParentClass  implements  \PDO, \DB {  // 写一行
 
}

(2)、属性(property)必须声明其可见性,到底是 public 还是 protected 还是 private,不能省略,也不能使用var, var是php老版本中的什么方式,等用于public。

1
2
3
4
5
6
7
8
<?php
namespace  Lib\Databaes;
 
class  Mysql  extends  ParentClass  implements  \PDO, \DB {  // 写一行
     public  $foo  = null;
     private  $name  'yangyi' ;
     protected  $age  '17' ;
}

(3)、方法(method),必须 声明其可见性,到底是 public 还是 protected 还是 private,不能省略。如果有多个参数,第一个参数后紧接“,” ,再加一个空格:function_name ($par, $par2, $pa3), 如果参数有默认值,“=”左右各有一个空格分开。

1
2
3
4
5
6
7
8
<?php
namespace  Lib\Databaes;
 
class  Mysql  extends  ParentClass  implements  \PDO, \DB {  // 写一行
     public  getInfo( $name $age $gender  = 1) {  // 参数之间有一个空格。默认参数的“=”左右各有一个空格,) 与 { 之间有一个空格
 
     }
}

(4)、当用到抽象(abstract)和终结(final)来做类声明时,它们必须放在可见性声明 (public 还是protected还是private)的前面。而当用到静态(static)来做类声明时,则必须放在可见性声明的后面。

直接上代码:

1
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值