PHP开发规范——代码规范篇(二):书写规范

统一的书写风格可以使得团队间的代码更容易融合和交流,也能够提升整个团队的开发效率。本篇将要提到的是: 代码缩进、大括号的使用格式、小括号的使用格式、控制语句格式格式、运算符的使用格式和折行显示 等规范。

1.代码缩进

代码使用四个字符的缩进方式,即使用四个空格的方式。如果编辑器将Tab
缩进设置为四字符也可以使用Tab缩进。

2.PHP代码标记

PHP代码标记 <?php 在文件开始顶格书写,省略结尾处的 ?> 标记。

例:

<?php
    //write your code...

3.长代码折行书写

一行代码的长度通常控制在120个字符,多余120个字符时需要将代码折行书写。折行点往往出现在:

  • 方法调用符号 -> 之前
  • 连接符 . 之前
  • 逗号 , 之后
  • 左大括号 { 之后
  • 左方括号 [ 之后

避免换行的点:

  • 括号之前
  • 左大括号 { 之前
  • 左方括号 [ 之前

折行后除了第一行之外,其他行都需要缩进4字符

4.大括号 {} 的使用

  • 作为 的界定符:左大括号 { 前后换行,右大括号 } 前后换行(使用PEAR推荐规范)
  • 作为 方法函数 的界定符:左大括号 { 前后换行,右大括号 } 前后换行(使用PEAR推荐规范)
  • 作为 控制语句块 的界定符:左大括号前不换行,之后换行,右大括号前后换行

例:

<?php
class Student
{
    public function getName($studentArr)
    {
        foreach ($studentArr as $student) {
            if (false != $student['status']) {
                //do sth.
            }
        }
    }
}

5.空格的使用

  • 关键词、保留字( if , foreach , switch 等)与小括号 () 之间使用一个空格
  • 方法函数名、类名和接口名等与小括号 () 之间不使用空格
  • 方法函数中的参数在定义和传入时出第一个参数外,之后其他参数与前一个参数之间保持一个空格,与后一个参数之间以逗号 , 分隔
  • 运算符前后各添加一个空格
  • 算术运算符: < > + - /
  • 赋值运算符: =
  • 逻辑运算符: && || ==
  • 三目运算符: : ?
    其他符号: . =>

6.空行的使用(推荐)

  • 不同逻辑块之间使用一个空行
  • 赋值语句与逻辑块之间使用一个空行
  • 不同业务逻辑使用一个空行
  • 其他视需要而定

7.其他约定

  • if ... else if ... else :在此判断语句中明建议使用else if ,不推荐使用 elseif
  • switch ... case:此控制语句中必须使用 default 结尾
  • if语句:在 if 语句中常量居左

例:

if (false != flag) {
    //your code
}
  • 减少 break continue goto的使用,尤其避免使用 goto 语句
  • 构造函数中避免进行业务逻辑处理,只进行赋值等简单操作
  • 不进行嵌入式的赋值

反例:if ($a != ($b = getChar())) { ... }

  • 不使用其他值如 10等来替代 bool 值,虽然在部分判断语句中可以等值替代,但是程序健壮性不佳
  • 不直接使用变量和函数来做判断条件,应该使用bool来比较

反例:

  • if ($a) { ... }
  • if (getStatus($a)) { ... }
    推荐:
    if (false == $a) { ... }
  • 定义数据块或数组时推荐将赋值运算符或其他运算符对齐书写

例:

$arr = [
    'name' => 'Choel',
    'age'  => '23',
    'class'=> '1'
]

由于本人学艺不精,未尽之处还望海涵,有误之处请多多指正,欢迎大家批评指教

本文 完

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

推荐阅读更多精彩内容

  • 第2章 基本语法 2.1 概述 基本句法和变量 语句 JavaScript程序的执行单位为行(line),也就是一...
    悟名先生阅读 4,207评论 0 13
  • [TOC] 前言 这份文档是Google Java编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的...
    marine8888阅读 1,963评论 0 1
  • 前言 本开发规范基于《阿里巴巴Java开发手册终极版》修改,并集成我们自己的项目开发规范,整合而成。 为表示对阿里...
    4ea0af17fd67阅读 5,667评论 0 5
  • 文/曹怀宁,国家二级心理咨询师 01 周末晚上,我受朋友小Z的邀请,参加了一场小型的讨论沙龙。小Z虽然不是情场高手...
    心理咨询师曹怀宁阅读 217评论 0 0
  • "悠悠的过去只是一片漆黑的天空,我们所以还能认识出来这漆黑的天空者,全赖思想家和艺术家所散布的几点星光。朋友,让我...
    梅拾璎阅读 4,503评论 173 277