Laravel框架开发规范-修订版

1.PHP编码规范

  1.1 标签

    PHP 程序可以使用<?php ?>或<?= ?>来界定PHP代码

    在HTML 页面中嵌入纯变量时,使用<?= ?>这样的形式

    纯PHP类文件,文件开始标签使用<?php,闭合标签?>必须省略

  1.2 编码

    PHP文件必须使用无BOM的UTF-8编码方式

  1.3 注释

    单行注释:在语句后面使用“//”注释

    多行注释:如下,注意换行

文件注释
/**
 * 描述
 *
 * @copyright Copyright&copy; 2016, 公司名称
 * @author zongshuai
 * @Date: 16/7/15
 * @Time: 下午5:45
 */

方法或者函数注释
/**
 * 描述
 *
 * @param 类型 $fields 描述
 * @param 类型 $fields 描述
 * @return 类型 描述
 */

属性注释
/**
* 描述
*
* @var 类型
*/

  1.4 命名规则

    类:文件名和类名必须一致,切采用首字母大写的驼峰命名法

    函数和方法:采用首字母小写的驼峰命名法,尽量用有意义,描述性的词语来命名,用checkForErrors()代替errorCheck(),用dumpDataToFile()代替dataFile()。

    变量名:

       用有意义的,描述性的词语来命名变量

       别用缩写。用name, address, salary 等代替 nam, addr, sal   全局变量以”g_” 开头

       别使用单个字母的变量象i, n, x 等. 使用 index, temp 等

    常量名:全部使用大写字母和下滑线组成,常量的名称中不允许出现小写字母,可使用分隔符作为下划线

  1.5 书写规则

    所有 PHP 文件必须以一个空行结束

    行实际长度不应超过 80 个字符;较长的行应当被拆分成多个不超过80 个字符的后续行。

    空行可以用来改善可读性和区分相关的代码块

    一行不应多于一个语句

    每个缩进的单位约定是4 个空格的缩进,并且不可使用制表符作为缩进,建议使用PhpStrom编辑器

    每个运算符与两边参与运算的值或表达式中间要有一个空格

    在绝大多数可以使用单引号的场合,禁止使用双引号(性能考虑)

    PHP所有关键字必须全部小写。常量 true 、false 和 null 也 必须 全部小写

    类的开始花括号({) 必须 写在函数声明后自成一行,结束花括号(})也 必须 写在函数主体后自成一行

    方法的开始花括号({) 必须 写在函数声明后自成一行,结束花括号(})也 必须 写在函数主体后自成一行

    方法名在声明之后不可跟随一个空格。左括号后面不可有空格,右括号前面不可有空格

    关键词 extends 和 implements 必须 写在类名称的同一行。implements 的继承列表也 可以 分成多行,这样的话,每个继承接口名称都 必须 分开独立成行,包括第一个

    类的属性和方法 必须 添加访问修饰符(privateprotected 以及 public),abstract 以及final 必须 声明在访问修饰符之前

    而 static 必须 声明在访问修饰符之后

    如果存在abstract 和final 声明必须放在可见性声明前面

    一定不可 使用关键字 var 声明一个属性。

    每条语句 一定不可 定义超过一个属性

    在参数列表中,逗号之前不可有空格,逗号之后必须要有一个空格

    方法中有默认值的参数必须放在参数列表的最后面

    参数列表可以被分为多个有一次缩进的多个后续行。如果这么做,列表的第一项必须放在下一行,并且每行必须只放一个参数。

    当参数列表被分为多行,右括号和左花括号必须夹带一个空格放在一起自成一行。

2.数据库命名规范

  2.1命名规范

时间: 2024-10-25 21:30:33

Laravel框架开发规范-修订版的相关文章

转:Laravel 项目开发规范

文件介绍很好 值得细细看看 https://www.jianshu.com/p/e464a35e5ed2 https://learnku.com/docs/laravel-specification/5.5 一. 说明 以下内容大部分引用Laravel China社区的文章 - 分享下团队的开发规范 ——<Laravel 项目开发规范>.相对而言,上面引用的文章的规范更加严格,但考虑到目前的情况,会适当地对一些规范进行更改和增删. 二. 目的 暂无 三. 优点 规范有一下优点: 高效编码 -

基于gulp的前端框架开发规范

前端开发及相关规范 - 基于gulp的前端框架开发规范 1.前端开发工具的安装和使用说明 前端开发工具的目录结构 htmlcodeBuilder - v0.9 ├── statics ├── html //静态文件开发 ├── js // 非require引入的js文件 ├── Lib // 第三方JS包 ├── ve_2_1 // ├── css // 样式目录 ├── fonts // bootstrap的图标字体 ├── img // 图片目录 ├── less // less源码 ├──

php的laravel框架使用心得

最近在做一项目,是基于laravel的后台api,用于与手机交互的,数据采用json格式.下面说下怎样在两周内把一个新框架或者语言用的得心应手. 项目采用laravel5.4+dingoapi+jwt,数据库使用model(orm)方式. 1.熟练使用工具,我平常看代码用sublime,很轻巧的工具.断点调试用phpstorm,api测试用postman(google浏览器插件),本地用phpstudy搭建环境 2.sublime就不说了,用起来比较简单.phpstorm配置调试,费了不少时间,

php后台开发(二)Laravel框架

php后台开发(二)Laravel框架 为了提高后台的开发效率,往往需要选择一套适合自己的开发框架,因此,选择了功能比较完善的Laravel框架,仔细学来,感觉和Python语言的框架Django非常类似. Laravel框架 Laravel是一套web应用开发框架,它具有富于表达性且简洁的语法,并提供了验证(authentication).路由(routing).session和缓存(caching)等开发过程中经常用到的工具或功能. 框架安装 安装composer http://docs.p

从零开始编写自己的C#框架(3)——开发规范

原文:从零开始编写自己的C#框架(3)--开发规范 由于是业余时间编写,而且为了保证质量,对写出来的东西也会反复斟酌,所以每周只能更新两章左右,请大家谅解,也请大家耐心等待,谢谢大家的支持. 初学者应该怎样学习本系列内容呢?根据我自己的学习经验,一般直接看一遍的方法,学习与认知都会比较浅,很快就忘了.而看完后写笔记.手抄或将所看的内容照着打一遍或多次的,可以比较深刻的理解文章或代码中的思想,并能将里面的核心内容牢记在心. 对于开发规范,都是老生常谈的事情了,很多正规一些的公司都有一套规范来约束,

Windows 7/8/10 系统下Laravel框架的开发环境安装及部署详解(Vagrant + Homestead)

注意! laravel/homestead box项目地址已经不再是原来的 https://atlas.hashicorp.com/laravel/boxes/homestead 而已经变更成 https://app.vagrantup.com/laravel/boxes/homestead 如果是刚刚接触Laravel的朋友,请直接按文中步骤操作.需要更新及重装的朋友们请注意使用第二个地址来进行文中操作. 虽然我通常习惯在Linux环境下工作,但对于一个从小就接触Windows的人来说,能够在

web前端开发规范

本文原创,这里首先声明,转载注明本文出处,翻版必究! web前端开发规范的现实意义 1.提高团队的协作能力 2.提高代码的重复利用率 3.可以写出质量更高,效率更好的代码 4.为后期维护提供更好的支持 5.可读性高 一.命名规则 1.html命名规则: a.文件名称命名规则:统一使用小写英文字母.数字.下划线的组合,不得包含汉字空格和特殊字符 2.命名原则:方便理解.方便查找 b.索引文件命名原则:index.html.index.htm.index.asp.index.aspx.index.j

Web前端开发规范文档(google规范)

(Xee:其实没什么规范约束,但是养成一种好习惯,何乐而不为?) 我推荐去看看google的开发规范,然后从他的当中去总结自己的开发规范. Google HTML/CSS代码风格指南 Google JavaScript 编码规范指南 ------------------------------------------------------------------------------------------------------------------------------- 绝大多数项

shell开发规范

版本1.0版,参考网上的一些文章规整而来.后期打算继续修改.完成一篇适合自己的shell开发规范. 最新编辑时间:2017.6.25 一. 命名规范 1. 版本和运行参数 1) 脚本开始之前以注释形式说明版本号:(推荐)2) 如果调用其他工具,还需说明工具的版本号:(推荐)3) 为脚本添加必须的运行参数,类似于C程序的运行参数,可使用getopt的方式取得运行参数值,如基本的参数有:-v - 版本号:-h – 帮助信息:(推荐) 2. 变量命名 1) 变量命名要前后统一,建议使用全部大写字母,如