Mod4-PHP编码规范

loading...

归纳总结了能找到的一些编码规范，形成自己所需要的编码规范。

参考网址：1、2

一、文件格式

1. 缩进使用四个空格，不使用制表符。左花括号不另起一行。

if (1 == $x) {
       $indented_code = 1;
       if (1 == $new_line) {
           $more_indented_code = 1;
       }
   }

1. 每行代码长度应控制在80个字符以内，最长不超过120个字符。因为 linux 读入文件一般以80列为单位，就是说如果一行代码超过80个字符，那么系统将为此付出额外操作指令。
2. 每行结尾不允许有多余的空格。

二、命名约定

1. 文件名只允许字母，使用驼峰法命名，并且首字母大写。
   
   例如：DbMysql.php
2. 方法名只允许由字母组成，下划线是不允许的，首字母要小写，其后每个单词首字母要大写，即所谓的 “驼峰法命名” 规则，且越详细越好，应该能够描述清楚该方法的功能。
   
   例如：switchModel、findPage
3. 属性的命名只允许由字母组成，下划线是不允许的，首字母要小写，其后每个单词首字母要大写，即所谓的 “驼峰法命名” 规则，例如tablePrefix、tableName 。
4. 函数的命名使用小写字母和下划线的方式，且越详细越好，应该能够描述清楚该函数的功能.
   
   例如：get_client_ip
5. 当方法或函数参数不一定需要被赋值的时候，用 "null" 来代替 "false" 作为函数参数的默认值，除非该参数是 boolean 值。
6. 类中的常量 constant 和全局范围内常量define，只能由大写字母和下划线组成，各个单词之间以下划线分割。
7. boolean 值和 null 值都采用小写。

三、编码风格

1. php 代码必须以完整的形式来定界<?php … ?>，即不要使用php 短标签<? … ?>，且保证在关闭标签后不要有任何空格。
2. 当一个字符串是纯文本组成的时候（即不含有变量），则必须总是以单引号（'）作为定界符。例如：
   
   $a = 'Example String';
3. 变量替换中的变量只允许用 $+变量名 的形式。例如：

$greeting = "Hello $name, welcome back!";   // 允许
$greeting = "Hello {$name}, welcome back!"; // 允许
$greeting = "Hello ${name}, welcome back!"; // 不允许

1. 当用点号 "." 连接各字符串的时候，字符串与点号间必须用一个空格隔开，且允许把它分割成多行以增强可读性。在这种情况下，点号 "." 必须与等于号 "=" 对齐。例如：

$sql = "SELECT `id`, `name` " . " FROM `people` "
      . "WHERE `name` = 'Susan' "
      . "ORDER BY `name` ASC ";

1. 当用 array 类型符号来构造数组的时候，必须在每个逗号之后加上一个空格来增强可读性。例如：$sampleArray = array(1, 2, 3, 'Think', 'SNS');
2. 当使用 array 类型符声明关联数组的时候，我们鼓励把它分成多个行，只是我们必须同时保证每行的键与值的对齐，以保持美观。例如：

$sampleArray = array(
                   'firstKey'  => 'firstValue',
                   'secondKey' => 'secondValue'
               );

1. 引用只允许定义在函数参数中，实时传递引用是禁止的。例如：

// 引用定义在函数参数-允许的
function defineRefInMethod(&$a){
    $a = 'a';
}
defineRefInMethod($b);
echo $b; // 'a'
// 实时传递引用-禁止的
function callTimePassRef($a){
    $a = 'a';
}
callTimePassRef(&$c);
echo $c; // 'a'

1. 基于"if", "else"和"else if"的条件控制里，我们必须用空格间隔开语句和括号，大括号的开始 "{" 必须与条件控制语句位于同一行，结束 "}" 必须总是独占一行且顶格，控制流程内容必须用四个空格进行缩进，且不使用"elseif"。

if ($condition) {
    // ...
} else if ($_condition) {
    // ...
} else {
    // ...
}

1. 在条件控制语句的条件括号内，必须用空格将操作符与其它元素隔开。如果遇到很长的逻辑判断，则鼓励用内嵌括号来分割各个逻辑。例如：

if (($a != 2) and ($b == 1)) {
    $a = $b;
}

1. "switch" 条件控制语句中，必须用空格将待测参数与其它元素分隔开。例如：

switch ($num) {
    // …
}

``. "switch" 语句的内容必须以四个空格缩进，"case" 条件控制的内容必须再加四个空格进行缩进。例如：

switch ($indentedSpaces) {
    case 2:
        echo "错误";
        break;
    case 4:
        echo "正确";
        break;
    default:
        break;
}

1. 在 "switch" 语句中应该总是包括 "default" 控制。
2. 有时候我们需要在 "case" 语境中省略掉 "break" 或 "return" ，这个时候我们必须为这些 "case" 语句加上 "// 此处无break" 注释。例如：

switch ($numPeople) {
case 1: // 此处无break
case 2:
      break;
default:
      break;
}