PHP编码规范及建议
<h3 align="center">PHP编码规范及建议</h3>
### 编码规范
- PHP代码文件必须以 <?php 标签开始。
```
<?php //开头
// 不结尾
```
- PHP代码文件必须以不带BOM的UTF-8编码。
```
例sublime, setting增加,"show_encoding" : true
```
- 每行的字符数不超过 80 个字符
```
例,sublime
"word_wrap": "true",
"wrap_width": 80,
```
- tap键4个空格
```
例,sublime
"tab_size": 4,
```
- PHP代码中应该只定义类(trait)/函数/常量/其他会产生副作用的操作(如:生成文件输出以及修改 .ini 配置文件等),只能选其一。
```
例,
a.php
class A
{
}
b.php
function demo()
{
}
c.php
define('A', value);
d.php
ini_set('some_vars', value);
```
- 类/trait/Interface的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范。
```
class StudlyCaps
{
}
trait StudlyCaps
{
}
Interface StudlyCaps
{
}
```
- 类中的常量所有字母都必须大写,单词间用下划线分隔。
```
define('FOO_BAR', 'something more');
const FOO_BAR = value;
```
- 方法(类/trait中)名称必须符合 camelCase 式的小写开头驼峰命名规范。
```
class StudlyCaps
{
public function studlyCaps()
{
// coding...
}
}
```
- 函数名称必须符合 snake_case 式的下划线式命名规范。
```
function snake_case()
{
// coding...
}
```
- 私有的(private)方法(类/trait中)名称必须符合 _camelCase 式的前置下划线小写开头驼峰命名规范。
```
class StudlyCaps
{
private function _studlyCaps()
{
// coding...
}
}
```
- 方法名称 第一个单词 为动词。
```
class StudlyCaps
{
public function doSomething()
{
// coding...
}
}
```
- 变量 必须符合 camelCase 式的小写开头驼峰命名规范。
```
class StudlyCaps
{
public function doSomething()
{
$someVariable = 'demo';
// coding...
}
}
```
- 方法/函数 多参数时,之间要有1个空格
```
class StudlyCaps
{
public function doSomething($variableOne, $variableTwo)
{
// coding...
}
}
```
- 运算符/表达式 要有一个空格
```
$a = $b + $c;
$a = $b . $c;
```
- 每个 namespace 命名空间声明语句块 和 use 声明语句块后面,必须 插入一个空白行。
```
namespace Standard;
// 空一行
use Test\TestClass;//use引入类
// 空一行
```
- 类的开始花括号 "{ "必须 写在函数声明后自成一行,结束花括号"}"也必须写在函数主体后自成一行。
```
class StudlyCaps
{
}
```
- 方法/函数的开始花括号 { 必须 写在函数声明后自成一行,结束花括号 }也 必须 写在函数主体后自成一行。
```
class StudlyCaps
{
public function studlyCaps()
{
// coding...
}
}
function snake_case()
{
// coding...
}
```
- 类的属性和方法 必须 添加访问修饰符(private、protected 以及 public),abstract 以及 final 必须 声明在访问修饰符之前,
而 static 必须 声明在访问修饰符之后。
```
abstract class StudlyCaps
{
abstract public function studlyCaps();
final public static function studlyCapsOne()
{
}
}
```
- 控制结构的关键字后 必须 要有一个空格符,而调用方法或函数时则 一定不可 有。
```
if ($valueOne === $valueTwo) {
// code...
}
switch ($valueThree) {
case 'value':
// code...
break;
default:
// code...
break;
}
do {
// code...
} while ($valueFour <= 10);
while ($valueFive <= 10) {
// code...
}
for ($i = 0; $i < $valueSix; $i++) {
// code...
}
$demo = new Demo()
$demo->doSomething();
do_something();
```
- 控制结构的开始花括号 { 必须 写在声明的同一行,而结束花括号 } 必须 写在主体后自成一行。
```
if ($valueOne === $valueTwo) {
// code...
}
switch ($valueThree) {
case 'value':
// code...
break;
default:
// code...
break;
}
do {
// code...
} while ($valueFour <= 10);
while ($valueFive <= 10) {
// code...
}
for ($i = 0; $i < $valueSix; $i++) {
// code...
}
```
- 控制结构的开始左括号后和结束右括号前,都一定不可有空格符。
```
if ($valueOne === $valueTwo) {// 控制结构(右边和)左边不加空格
// code...
}
```
### 编码建议
- sql过长
```
// heredoc语法
$sql = <<<SQL
SELECT delivery_id
FROM d_test
WHERE delivery_id
IN (123,234)
GROUP BY delivery_id
HAVING SUM(send_number) <= 0;
SQL;
```
- if等控制结构条件过长
```
if ($a > 0
&& $b > 0
&& $c > 0
&& $d > 0
&& $e > 0) {
}
```
- 方法或函数参数大于三个换行
```
public function tooLangFunction(
$valueOne = '',
$valueTwo = '',
$valueThree = '',
$valueFour = '',
$valueFive = '',
$valueSix = '')
{
//coding...
}
```
- 链式操作超过两个
```
$this->nameTest->functionOne()
->functionTwo()
->functionThree();
```
- 数组php5.4以后,使用[]
```
$a = [
'aaa' => 'aaa',
'bbb' => 'bbb'
];
```
- 单引号多引号
- 字符串中无变量,单引号
- 字符串中有变量,双引号
```
$str = 'str';
$arg = "$str";
```
- 声明类或者方法或函数添加描述&属性描述&作者
```
/**
* 类描述
*
* desc
*/
class StandardExample
{
/**
* 常量描述.
*
* @var string
*/
const THIS_IS_A_CONST = '';
/**
* 属性描述.
*
* @var string
*/
public $nameTest = '';
/**
* 构造函数.
*
* 构造函数描述
* @author name <email>
* @param string $value 形参名称/描述
* @return 返回值类型 返回值描述
* 返回值类型:string,array,object,mixed(多种,不确定的),void(无返回值)
*/
public function __construct($value = '')
{
// coding...
}
```
- api方法提供测试样例example
```
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @example domain/api/controller/action?argu1=111&argu2=222
*/
public function testFunction($value = '')
{
// code...
}
```
- 使用try...catch...
```
try {
// coding...
} catch (\Exception $e) {
// coding...
}
```
- 连续调用多个方法(大于3个)使用foreach
```
// 改写doSome为doSomething
class StandardExample
{
/**
* 方法列表
*
* @var array
*/
private $_functionList = [];
public function __construct($functionList = array())
{
$this->_functionList = $value;
}
public function doSome()
{
$this->functionOne();
$this->functionTwo();
$this->functionThree();
$this->functionFour();
}
public function doSomething()
{
foreach($this->_functionList as $function) {
$this->$function();
}
}
...
}
```
- 文件顶部进行版权声明
```
// +----------------------------------------------------------------------
// | Company Name xx服务
// +----------------------------------------------------------------------
// | Copyright (c) 2017 http://domain All rights reserved.
// +----------------------------------------------------------------------
// | Author: name <email>
// +----------------------------------------------------------------------
```
PHP编码规范及建议的更多相关文章
- Python 常用 PEP8 编码规范和建议
代码布局 缩进 每级缩进用4个空格. 括号中使用垂直隐式缩进或使用悬挂缩进. EXAMPLE: # (垂直隐式缩进)对准左括号 foo = long_function_name(var_one, va ...
- Python编码规范(PEP8)
Introduction 介绍 本文提供的Python代码编码规范基于Python主要发行版本的标准库.Python的C语言实现的C代码规范请查看相应的PEP指南1. 这篇文档以及PEP 257(文档 ...
- Python PEP 8 编码规范中文版
原文链接:http://legacy.python.org/dev/peps/pep-0008/ 转发链接:https://blog.csdn.net/ratsniper/article/detail ...
- Python代码编码规范
目录 1. Introduction 介绍 2. A Foolish Consistency is the Hobgoblin of Little Minds 尽信书,则不如无书 3. Code la ...
- 【翻译】Python PEP8编码规范(中文版)
原文链接:http://legacy.python.org/dev/peps/pep-0008/ item detail PEP 8 Title Style Guide for Python Code ...
- 【转】Android编码规范建议18条
转自:http://www.chinaz.com/design/2015/0908/443732.shtml Android编码规范建议18条 适合手机app设计师和android 工程师阅读. 1. ...
- PHP编码规范建议学习
###php编码规范 -------* sql过长 ```$sql = <<<SQLSELECT delivery_idFROM d_testWHERE delivery_idIN ...
- 【原】JAVA SE编码规范
/* * 编码规范: * 1.所有的命名遵循"见名知意"的原则 * 2.所有的命名不允许使用汉字或拼音 * 3.Java的工程命名建议使用小写,比如:oa.crm.cms... * ...
- 浅谈Android编码规范及命名规范
前言: 目前工作负责两个医疗APP项目的开发,同时使用LeanCloud进行云端配合开发,完全单挑. 现大框架已经完成,正在进行细节模块上的开发 抽空总结一下Android项目的开发规范:1.编码规范 ...
随机推荐
- ASP.NET网页发布以及相关问题的解决
今天做了一个统计站点的网页,想要发布一下,中间碰到不少问题,现在和大家分享一下! 这是我想要最终的网页结果: 1.发布站点到桌面(任意路径) 2.安装IIS 3.安装好后,打开IIS, ...
- 最短的IE判断var ie=!-[1,]分析
以前最短的IE判定借助于IE不支持垂直制表符的特性搞出来的. 复制代码代码如下: var ie = !+"\v1"; 仅仅需要7bytes!参见这篇文章,<32 byte ...
- Xamarin.Android 使用Timer 并更改UI
http://blog.csdn.net/ozhangsan12345/article/details/72653070 第一步:创建timer对象 //创建timer对象 Timer _dispat ...
- SQLSERVER 死锁标志
最开始做DBA的时候,整天死锁到头痛1222,至今都能回想到这个错误窗口: 死锁定义:死锁是指在一组进程中的各个进程均占有不会释放的资源,但因互相申请被其他进程所站用不会释放的资源而处于的一种永久等待 ...
- golang 多维数组
具体的题目如下:(就是将多维数组的行列互换) A multi-dimensional array is an array of arrays. 2-dimensional arrays are the ...
- C#对象深度克隆
有基础的开发者都应该很明白,对象是一个引用类型,例如: object b=new object(); object a=b; 那么a指向的是b的地址,这样在有些时候就会造成如果修改a的值,那么b的值也 ...
- 调出js控制台可以在浏览器地址栏输入about:blank
调出js控制台可以在浏览器地址栏输入about:blank,如果不输入about:blank,直接 打开一个新的页面,有可能输出的结果不准确.也就是说变量有可能被其他的影响到, 造成结果不准确.
- EMMC与nand flash的区别【转】
1.NAND Flash 是一种存储介质,要在上面读写数据,外部要加主控和电路设计. 2.eMMC是NAND flash+主控IC ,对外的接口协议与SD.TF卡类似:对厂家而言简化了电路设计,降低了 ...
- linux连接mysql 出现Access denied for user 'root'@'localhost'(using password: YES)错误解决方案
linux连接mysql /usr/local/mysql/bin/mysql -uroot -p 输入密码出现Access denied for user 'root'@'localhost'(us ...
- hdu 5919--Sequence II(主席树--求区间不同数个数+区间第k大)
题目链接 Problem Description Mr. Frog has an integer sequence of length n, which can be denoted as a1,a2 ...