PHP团队 编码规范 & 代码风格规范

一、基本约定

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;

二、代码风格

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

先简单文字描述下:

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

用代码来说明下:

<?php
namespace Lib\Databases; // 下面必须空格一行

class Mysql
{

}

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

<?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 写在一行,且花括号要换行写。

<?php
namespace Lib\Databaes;

class Mysql extends ParentClass implements \PDO, \DB // 写一行
{ // 换行写 {

}

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

<?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), 如果参数有默认值,“=”左右各有一个空格分开。

<?php
namespace Lib\Databaes;

class Mysql extends ParentClass implements \PDO, \DB // 写一行
{
	public getInfo($name, $age, $gender = 1) // 参数之间有一个空格。默认参数的“=”左右各有一个空格
	{ // 必须换行写 {

	}
}

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

直接上代码:

<?php
namespace Vendor\Package;

abstract class ClassName
{
	protected static $foo; // static放后面

	abstract protected function zim(); // abstract放前面

	final public static function bar() // final放前面,static放最后。
	{
		// 方法主体部分
	}
}

3、控制结构

控制接口,就是 if else while switch等。这一类的写法规范也是经常容易出现问题的,也要规范一下。

(1)、if,elseif,else写法,直接上规范代码吧:

<?php
if ($expr1) // if 与 ( 之间有一个空格
{ // 必须换行写 {

}
elseif ($expr2) // elesif 连着写,与 ( 之间有一个空格
{ // 必须换行写 {

}
else
{ // 必须换行写 {

}

(2)、switch,case 注意空格和换行,还是直接上规范代码:

<?php
switch ($expr) // switch 与 ( 之间有一个空格
{ // 必须换行写 {
	case 0:
		echo ‘First case, with a break‘; // 对齐
		break; // 换行写break,也对齐。
	case 1:
		echo ‘Second case, which falls through‘;
		// no break
	case 2:
	case 3:
	case 4:
		echo ‘Third case, return instead of break‘;
		return;
	default:
		echo ‘Default case‘;
		break;
}

(3)、while,do while 的写法也是类似,上代码:

<?php
while ($expr) // while 与 ( 之间有一个空格
{ // 换行写 {

}

do
{ // 换行写 {

} while ($expr); // while 左右各有一个空格

(4)、for的写法

<?php
for ($i = 0; $i < 10; $i++) // for 与 ( 之间有一个空格,二元操作符 "="、"<" 左右各有一个空格
{ // 换行写 {

}

(5)、foreach的写法

<?php
foreach ($iterable as $key => $value)// foreach 与 ( 之间有一个空格,"=>" 左右各有一个空格
{ // 换行写 {

}

(6)、try catch的写法

<?php
try
{ // 换行写 {

}
catch (FirstExceptionType $e) // catch 与 ( 之间有一个空格
{ // 换行写 {

}
catch (OtherExceptionType $e) // catch 与 ( 之间有一个空格
{ // 换行写 {

}

4、注释

(1)、行注释

// 后面需要加一个空格;

如果 // 前面有非空字符,则 // 前面需要加一个空格;

(2)函数注释

参数名、属性名、标签的文本 上下要对齐;

在第一个标签前加一个空行;

<?php
/**
 * This is a sample function to illustrate additional PHP
 * formatter options.
 *
 * @param        $one   The first parameter
 * @param int    $two   The second parameter
 * @param string $three The third parameter with a longer
 *                      comment to illustrate wrapping.
 * @return void
 * @author  52php.cnblogs.com
 * @license GPL
 */
function foo($one, $two = 0, $three = "String")
{

}

参考:

代码风格研究:左花括号 是否换行???

PHP中PSR-[0-4]代码规范

时间: 2024-08-23 14:40:23

PHP团队 编码规范 & 代码风格规范的相关文章

PHP PSR-2 代码风格规范 (中文版)

代码风格规范 本篇规范是 PSR-1 基本代码规范的继承与扩展. 本规范希望通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 当多名程序员在多个项目中合作时,就需要一个共同的编码规范,而本文中的风格规范源自于多个不同项目代码风格的共同特性,因此,本规范的价值在于我们都遵循这个编码风格,而不是在于它本身. 关键词 "必须"("MUST")."一定不可/一定不能"("MUST NOT"

前端CSS和JS代码风格规范

1:不要轻易改动全站级CSS和通用CSS库.改动后,要经过全面测试. 2:css的id,class 名称 语义化,   以 - 相连,   命名少用缩写(除一些所有人一看便知的缩写); 3: Javascript命名规则 3.1:私有变量名用下划线开头; eg: _this = $(this); 3.2:变量名--驼峰命名法; eg: regEmail; 3.3:格式化对象参数;   eg: $.ajax({ type : 'post', url : '/auth/sendCode', data

PSR-2 代码风格规范

这篇规范是PSR-1(基本代码规范)的扩展和继承. 本规通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便. 这个风格规范是从各种各样的项目的共性中延伸出来的.当多名程序员在多个项目中合作时,它有助于有一套准则,在所有的项目中使用. 因此,本指南的好处不是在规则本身,而是在这些规则的共享. 关键词 "必须"("MUST")."一定不可/一定不能"("MUST NOT")."

.net 代码风格规范

声明:内容非原创,转自张子阳博客. 对于为什么是转载,唯一原因就是这东西居然比我整理的好,直接用得了. 1. C# 代码风格要求 1.1注释 类型.属性.事件.方法.方法参数,根据需要添加注释. 如果类型.属性.事件.方法.方法参数的名称已经是自解释了,则不需要加注释:否则必须添加注释. 当添加注释时,添加方式如下图所示: 1.2 类型(类.结构.委托.接口).字段.属性.方法.事件的命名 优先考虑英文,如果英文没有合适的单词描述,可以使用拼音,使用中文是不符合要求的. 唯一可以使用中文的地方是

.Net 项目代码风格规范

最近没啥时间自己状态也不是很好,公司的事情忙,自己也有一些事情要处理,所以好久没有写博客了.利用公司午休时间写一写,以下是参考了一些资料,整理出来,共勉之. 代码风格没有正确与否,重要的是整齐划一,清晰易读. 1. C# 代码风格要求 1.1注释 类型.属性.事件.方法.方法参数,根据需要添加注释. 如果类型.属性.事件.方法.方法参数的名称已经是自解释了,不需要加注释:否则需要添加注释. 当添加注释时,添加方式如下图所示: 1.2 类型(类.结构.委托.接口).字段.属性.方法.事件的命名 优

前端代码风格规范总结

规范目的:为了提高工作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档,在网站建设中,使结构更加清晰,代码简明有序,有一个更好的前端架构. 规范基本准则:符合web标准,使用具有语义的标签,使结构.表现.行为分离,兼容性优良.页面性能优化,代码简洁.明了.有序,尽可能的减少服务器的负载,保证最快的解析速度. 一.文件规范 1.1 HTML部分 1.1.1 建包问题 文件均归档至约定的目录中,建包格式如下: 注意:所有的css文件放在css文件夹中,image放在images文件夹中

PHP 权威代码风格规范

1.常规 尽量统一ide 比如phpstream 配置文件(Settings → Code Style → PHP → Set from... → Predefined Style → PSR1/PSR2) 看标准 操作 缩进一定要用4个空格代替tab键 文件名 StudlyCaps 类名 StudlyCaps 常量 大写字母单词 _ 分隔单词 方法 变量 属性 camelCase 私有属性 __开头 代码列 最好不要超过 120 单个函数 不要超过 100 行 2.文件 文件命名 Studly

Linux内核编程规范与代码风格

source: https://www.kernel.org/doc/html/latest/process/coding-style.html translated by trav, [email protected] 这是一篇阐述Linux内核编程代码风格的文档,译者以学习为目的进行翻译. 1 缩进 Tab的宽度是八个字符,因此缩进的宽度也是八个字符.有些异教徒想让缩进变成四个字符,甚至是两个字符的宽度,这些人和那些把 PI 定义为 3 的人是一个路子的. 注意:缩进的全部意义在于清晰地定义

Angular(03)-- lint风格规范和WebStorm小技巧

在开始讲 Angular 各个核心知识点之前,想先来讲讲开发工具 WebStorm 的一些配置以及相应配置文件如 tslint.json 的配置. 因为我个人比较注重代码规范.代码风格,而对于这些规范,我只有一个观点:一切需要依赖开发人员的主观意识去遵守的规范都没有多大意义. 以前做 Android 开发时会借助 AndroidStudio 来强制遵守一些规范,现在前端项目我用的是 WebStorm 开发,这两个开发工具本质上同源,所以很多功能都差不多. 那么,这篇就来讲一讲,如何对 WebSt