作者：烨竹

如果使用以下的代码规范：更显的你像一个老司机

[PHP 结束标签]

PHP 结束标签 ?> 对于 PHP 解析器来说是可选的，但是只要使用了，结束标签之后的空格 有可能会导致不想要的输出，这个空格可能是由开发者或者用户又或者 FTP 应用程序引入的， 甚至可能导致出现 PHP 错误，如果配置了不显示 PHP 错误，就会出现空白页面。基于这个原因， 所有的 PHP 文件将不使用结束标签，而是以一个空行代替。

[文件的命名]

类文件的命名必须以大写字母开头，其他文件（配置文件，视图，一般的脚本文件等）的命名是全小写。
另外，类文件的名称必须和类的名称保持一致，例如，如果你有一个类名为 Myclass， 那么文件名应该是 Myclass.php

Somelibrary.php
Some_library.php

applicationconfig.php
application_config.php

[类和方法的命名]

类名必须以大写字母开头，多个单词之间使用下划线分割，不要使用驼峰命名法。

class Super_class {

    public function __construct()
    {

    }
}

类的方法应该使用全小写，并且应该明确指出该方法的功能，最好包含一个动词；避免使用冗长的名称，多个单词之间使用下划线分割

  function get_file_properties() 

[变量的命名]

变量的命名规则和类方法的命名规则非常接近，使用全小写，使用下划线分割， 并且应该明确指出该变量的用途。非常短的无意义的变量只应该在 for 循环中作为迭代器使用。

    for ($j = 0; $j < 10; $j++)
    $str
    $buffer
    $group_id
    $last_city

[注释]

通常情况下，应该多写点注释，这不仅可以向那些缺乏经验的程序员描述代码的流程和意图， 而且当你几个月后再回过头来看自己的代码时仍能帮你很好的理解。 注释并没有强制规定的格式，但是我们建议以下的形式。

DocBlock 风格的注释，写在类、方法和属性定义的前面，可以被 IDE 识别:

    /**
     * Super Class
     *
     * @package Package Name
     * @subpackage  Subpackage
     * @category    Category
     * @author  Author Name
     * @link    http://example.com
     */
    class Super_class {

单行注释应该和代码合在一起，大块的注释和代码之间应该留一个空行

// break up the string by newlines
$parts = explode("\n", $str);

// A longer comment that needs to give greater detail on what is
// occurring and why can use multiple single-line comments.  Try to
// keep the width reasonable, around 70 characters is the easiest to
// read.  Don't hesitate to link to permanent external resources
// that may provide greater detail:
//
// http://example.com/information_about_something/in_particular/

$parts = $this->foo($parts);

[常量]

常量遵循和变量一样的命名规则，除了它需要全部大写。**尽量使用 CodeIgniter 已经定义好的常量， 如：SLASH、LD、RD、PATH_CACHE 等。

MY_CONSTANT
NEWLINE
SUPER_CLASS_VERSION
$str = str_replace(LD.'foo'.RD, 'bar', $str);

[TRUE、FALSE 和 NULL]

TRUE 、 FALSE 和 NULL 这几个关键字全部使用大写

if ($foo == TRUE)
$bar = FALSE;
function foo($bar = NULL)

[逻辑操作符]

不要使用 || 操作符，它在一些设备上看不清（可能看起来像是数字 11）， 使用 && 操作符比使用 AND 要好一点，但是两者都可以接受。 另外，在 ! 操作符的前后都应该加一个空格

if ($foo OR $bar)
if ($foo && $bar) // recommended
if ( ! $foo)
if ( ! is_array($foo))

[对返回值进行比较以及类型转换]

有一些 PHP 函数在失败时返回 FALSE ，但是也可能会返回 "" 或 0 这样的有效值， 这些值在松散类型比较时和 FALSE 是相等的。所以当你在条件中使用这些返回值作比较时， 一定要使用严格类型比较，确保返回值确实是你想要的，而不是松散类型的其他值。
在检查你自己的返回值和变量时也要遵循这种严格的方式，必要时使用 === 和 !== 。

function build_string($str = "")
{
    if ($str === "")
    {

    }
}

另外关于 类型转换 的信息也将很有用。 类型转换会对变量产生一点轻微的影响，但可能也是期望的。例如 NULL 和 布尔值 FALSE 会转换为空字符串， 数字 0 （和其他数字）将会转换为数字字符串，布尔值 TRUE 会变成 "1":

$str = (string) $str;

[调试代码]

不要在你的提交中包含调试代码，就算是注释掉了也不行。 像 var_dump() 、 print_r() 、 die() 和 exit() 这样的函数，都不应该包含在你的代码里， 除非它们用于除调试之外的其他特殊用途。

[文件中的空格]

PHP 起始标签的前面和结束标签的后面都不要留空格，输出是被缓存的，所以如果你的文件中有空格的话， 这些空格会在输出它的内容之前被输出，从而会导致错误，而且也会导致无法发送正确的头信息。

[空格]

在代码中使用制表符（tab）来代替空格，这虽然看起来是一件小事，但是使用制表符代替空格， 可以让开发者阅读你代码的时候，可以根据他们的喜好在他们的程序中自定义缩进。 此外还有一个好处是，这样文件可以更紧凑一点，也就是本来是四个空格字符， 现在只要一个制表符就可以了。

[换行]

文件必须使用 Unix 的换行格式保存。这对于那些在 Windows 环境下的开发者可能是个问题， 但是不管在什么环境下，你都应该确认下你的文本编辑器已经配置好使用 Unix 换行符了。

[代码缩进]

使用 Allman 代码缩进风格。除了类的定义之外，其他的所有大括号都应该独占一行， 并且和它对应的控制语句保持相同的缩进。

function foo($bar)
{
// ...
}

[中括号和小括号内的空格]

一般情况下，使用中括号和小括号的时候不应该使用多余的空格。 唯一的例外是，在那些接受一个括号和参数的 PHP 的控制结构（declare、do-while、elseif、for、 foreach、if、switch、while）的后面应该加一个空格，这样做可以和函数区分开来，并增加可读性。

[短标记]

使用 PHP 的完整标记，防止服务器不支持短标记（ short_open_tag ）参数。

<?php echo $foo; ?>

[字符串]

字符串使用单引号引起来，当字符串中有变量时使用双引号，并且使用大括号将变量包起来。 另外，当字符串中有单引号时，也应该使用双引号，这样就不用使用转义符。

'My String'
"My string {$foo}"
"SELECT foo FROM bar WHERE baz = 'bag'"

[每行只有一条语句]

  $foo = 'this';
  $bar = 'that';
  $bat = str_replace($foo, $bar, $bag);

[SQL 查询]

SQL 关键字永远使用大写：SELECT、INSERT、UPDATE、WHERE、AS、JOIN、ON、IN 等。

考虑到易读性，把长的查询分成多行，最好是每行只有一个从句或子从句。

    $query = $this->db->query("SELECT foo, bar, baz, foofoo, foobar AS raboof, foobaz
            FROM exp_pre_email_addresses
            WHERE foo != 'oof'
            AND baz != 'zab'
            ORDER BY foobaz
            LIMIT 5, 100");

[缺省的函数参数]

适当的时候，提供函数参数的缺省值，这有助于防止因错误的函数调用引起的PHP错误， 另外提供常见的备选值可以节省几行代码。例如: