PHP 代码规范 (Rohn Style)

PHP 代码文件

  • 必须<?php 开头,不能用<? 以免配置为short_open_tag = off 时造成出错;
  • 必须以不带BOM的 UTF-8 编码;
  • 纯PHP代码的文件关闭标签?>必须省略;

命名规则

  • 类 -- 必须按照大写开头的驼峰式命名;
    class HelloWorld
  • 方法 -- 必须按照小写开头的驼峰式命名;
    public function helloFunction()
  • 属性 -- 必须以小写开头的驼峰式命名;
    $helloAttribute
  • 常量 -- 所有字母都必须大写,词间以下划线分隔;
    const HELLO_WORLD = 'hello world'
  • 私有 -- 属性和方法都必须_ 开头;
    private function _helloFunction()
    private $_helloWorld
  • 参数&临时变量 -- 字母全小写,词间以下划线分割;
    $hello_world

布局

  • 在namespace声明下面必须有一个空行,并且use声明代码块下面也必须有一个空行;
  • 类和方法的左花括号必须放到下一行,右花括号必须放在主体的下一行;
class HelloWord
{
        function __construct()
        {
                echo 'hello world';
        }
}
  • 控制结构:
  • 关键词有()的时候,()左右两端外界各留一个空格,方法和函数不可有;
  • 左花括号必须放在同一行,右花括号必须放在控制主体的下一行;
  • 右花括号必须与控制结构关键词左侧对齐;
if ($hello_world == true) {//()两端外界都有一个空格
      //控制主体
}//与if对齐

function helloWorld (){} //()前面的空格

  • 参数列表:
  • ,之后要有一个空格;
  • 方法中有默认值的参数必须放在参数列表的最后面;
  • 参数列表可以被分为多个有一次缩进的多个后续行。如果这么做,列表的第一项必须放在下一行,并且每行必须只放一个参数;
function helloWorld($arg1, &$arg2, $arg3='test'){}

function multLines(
      $arg1,
      &$arg2,
      $arg3='test'
){}

其他

  • 一个文件中最多只有一个类;
  • 一行代码的长度尽量控制在120个字符以内;
  • 一个class不要超过500行有效代码;
  • PHP关键词true, falsenull必须使用小写;
  • 类方法中不要出现$_SERVER、$_GET、$_POST等,要通过形参传递到类方法。

更多细节可参考 PSR

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 整理自 PHP 标准规范 作为程序员来说,采用统一的编码风格是非常重要的。这将给未来代码的编写、阅读节省大量时间。...
    野尘lxw阅读 3,966评论 0 2
  • 一、php可以做什么 php是一种可以在服务器端运行的编程语言,可以运行在Web服务器端。 php是一门后台编程语...
    空谷悠阅读 8,322评论 4 97
  • ¥开启¥ 【iAPP实现进入界面执行逐一显】 〖2017-08-25 15:22:14〗 《//首先开一个线程,因...
    小菜c阅读 11,817评论 0 17
  • 第5章 引用类型(返回首页) 本章内容 使用对象 创建并操作数组 理解基本的JavaScript类型 使用基本类型...
    大学一百阅读 8,466评论 0 4
  • Description: - In these Free Investment Banking Courses, ...
    jimmie123阅读 3,068评论 0 1