关于一些php规范
<?php
/**
* 符合psr-1,2的编程实例
*
* @author GreenForestQuan
*/
namespace Standard; // 顶部命名空间
// 空一行
use Test\TestClass;//use引入类
/**
* 类描述
*
* 类名必须大写开头驼峰.
*/
abstract class StandardExample // {}必须换行
{
/**
* 常量描述.
*
* @var string
*/
const THIS_IS_A_CONST = ''; // 常量全部大写下划线分割
/**
* 属性描述.
*
* @var string
*/
public $nameTest = ''; // 属性名称建议开头小写驼峰
// 成员属性必须添加public(不能省略), private, protected修饰符
/**
* 属性描述.
*
* @var string
*/
private $_privateNameTest = ''; // 类私有成员属性,【个人建议】下划线小写开头驼峰
/**
* 构造函数.
*
* 构造函数描述
*
* @param string $value 形参名称/描述
*/
public function __construct($value = '')// 成员方法必须添加public(不能省略), private, protected修饰符
{// {}必须换行
$this->nameTest = new TestClass();
// 链式操作
$this->nameTest->functionOne()
->functionTwo()
->functionThree();
// 一段代码逻辑执行完毕 换行
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
* 返回值类型:string,array,object,mixed(多种,不确定的),void(无返回值)
*/
public function testFunction($value = '')// 成员方法必须小写开头驼峰
{
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
private function _privateTestFunction($value = '')// 私有成员方法【个人建议】下划线小写开头驼峰
{
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
public static function staticFunction($value = '')// static位于修饰符之后
{
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
abstract public function abstractFunction($value = ''); // abstract位于修饰符之前
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
final public function finalFunction($value = '')// final位于修饰符之前
{
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $valueOne 形参名称/描述
* @param string $valueTwo 形参名称/描述
* @param string $valueThree 形参名称/描述
* @param string $valueFour 形参名称/描述
* @param string $valueFive 形参名称/描述
* @param string $valueSix 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
public function tooLangFunction(
$valueOne = '', // 变量命名可小写开头驼峰或者下划线命名,个人那习惯,据说下划线可读性好
$valueTwo = '',
$valueThree = '',
$valueFour = '',
$valueFive = '',
$valueSix = '')// 参数过多换行
{
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...
}
}
}
编码规范 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规范的更多相关文章
- iOS代码规范(OC和Swift)
下面说下iOS的代码规范问题,如果大家觉得还不错,可以直接用到项目中,有不同意见 可以在下面讨论下. 相信很多人工作中最烦的就是代码不规范,命名不规范,曾经见过一个VC里有3个按钮被命名为button ...
- node.js学习(三)简单的node程序&&模块简单使用&&commonJS规范&&深入理解模块原理
一.一个简单的node程序 1.新建一个txt文件 2.修改后缀 修改之后会弹出这个,点击"是" 3.运行test.js 源文件 使用node.js运行之后的. 如果该路径下没有该 ...
- 百度MIP页规范详解 —— canonical标签
百度MIP的规范要求必须添加强制性标签canonical,不然MIP校验工具会报错: 强制性标签<link rel="/^(canonical)$/"> 缺失或错误 这 ...
- JavaScript var关键字、变量的状态、异常处理、命名规范等介绍
本篇主要介绍var关键字.变量的undefined和null状态.异常处理.命名规范. 目录 1. var 关键字:介绍var关键字的使用. 2. 变量的状态:介绍变量的未定义.已定义未赋值.已定义已 ...
- JavaScript 开发规范
本篇主要介绍JS的命名规范.注释规范以及框架开发的一些问题. 目录 1. 命名规范:介绍变量.函数.常量.构造函数.类的成员等等的命名规范 2. 注释规范:介绍单行注释.多行注释以及函数注释 3. 框 ...
- c#语言规范
0x00 分类 C#语言规范主要有两个来源,即我们熟知的ECMA规范和微软的规范.尽管C#的ECMA规范已经前后修订4次,但其内容仅仅到C# 2.0为止.所以慕容为了方便自己和各位方便查询,在此将常见 ...
- OSGi规范的C#实现开源
这是大约在3-4年前完成的一个C#实现的OSGi框架,实现的过程参照了OSGi规范与与一些实现思路(感谢当时的那些资料与项目),此框架虽然仅在几个小型项目有过实际的应用,但OSGi的规范实现还是相对比 ...
- 【腾讯优测干货分享】如何降低App的待机内存(二)——规范测试流程及常见问题
本文来自于腾讯优测公众号(wxutest),未经作者同意,请勿转载,原文地址:https://mp.weixin.qq.com/s/806TiugiSJvFI7fH6eVA5w 作者:腾讯TMQ专项测 ...
- 超炫的HTML5粒子效果进度条 VS 如何规范而优雅地code
最近瞎逛的时候发现了一个超炫的粒子进度效果,有多炫呢?请擦亮眼镜! // _this.ch){ _this.particles.splice(i, 1); } }; this.Particle.p ...
- 我的公司培训讲义(1):.NET开发规范教程
这是1年多以前我在公司所做讲座的讲义,现在与园友们分享,欢迎拿去使用.一起讨论.文中有若干思考题,对园友们是小菜一碟.另有设计模式讲义一篇,随后发布.博文上了首页,感谢博客园团队推荐,也感谢所有园友的 ...
随机推荐
- Personal Learning Path of Java——Java语言基础
Java语言是面向对象编程语言,Java程序的基本组成单元是类,类体中又包括属性和方法两部分.每一个程序都必须包含一个main()方法,含有main()方法的类称为主类. 如下面代码: package ...
- vim编辑操作
vim 插入模式 a 光标后 A 行尾 o 光标所在行下一行 O 光标所在行上一行 i 光标前 ...
- robotframework安装及入门指南
将很久之前自己在本地记录的一些笔记发表到随笔来,希望能够帮到一些童鞋~ robotframework安装及入门指南 本文主要介绍robotframework在windows环境的安装过程! 安装步骤 ...
- Ubuntu 安装 Nginx 实现反向代理
安装Nginx依赖库(ubuntu平台) 最近域名通过了备案, 想着应用总不能带着端口号访问吧, 于是在网上踩了很多坑, 终于找到了一步直达的方法,起码这一次很顺利的实现了 安装gcc g++的依赖库 ...
- js promise看这篇就够了
一.背景 大家都知道nodejs很快,为什么会这么快呢,原因就是node采用异步回调的方式来处理需要等待的事件,使得代码会继续往下执行不用在某个地方等待着.但是也有一个不好的地方,当我们有很多回调的时 ...
- tomcat启动报错
[toc]启动错误 does not exist or is not a readable directory 问题:tomcat启动报错:does not exist or is not a rea ...
- XML (二)
1 SAX 在使用DOM解析XML文档的时候,需要读取整个XML文档,在内存中构架代表整个DOM树的Document对象,从而再对XML文档进行操作.此种情况下,如果XML文档特别大,就会消耗计算机的 ...
- 我的踩坑之旅-代码不规范引发的“bug”
今早公司上班,老大跟我说有一个服务老是上线,下线,问我啥情况.我回想了下我的项目部署,觉得不可能会出现这个问题呀.然后各种鼓捣,倒腾了一个早上,终于找出了罪魁祸首. 场景:我们的服务部署在亚马逊上.我 ...
- php与HTML交互问题
1.将表单中的action属性值设为PHP路径,则网页会跳转到这个网址 <html> <body> <form action="welcome.php" ...
- Java基础知识(一)
类与对象 1.对象:客观存在的一切事物称之为对象 类:具有相同属性和方法的对象的集合 2.类:属性,方法 3.修饰符: public protected 默认(不写) private 任何地方 ...