为了便于规范自己的代码,参考了 CodeIgniter、Laravel、PSR等相关规范,做一个PHP代码规范的小结。
[TOC] ## 文件格式
PHP代码文件必须以 不带BOM的 UTF-8编码。
所有PHP文件必须使用 Unix LF (linefeed)作为行的结束符。
所有PHP文件必须以一个空白行作为结束。
纯PHP代码文件必须省略最后的 ?>结束标签。
类文件的命名必须以大写字母开头,其他文件(配置文件,视图,一般的脚本文件等)的命名是全小写。另外,类文件的名称必须和类的名称保持一致。
通常情况下,应该多写点注释,这不仅可以向那些缺乏经验的程序员描述代码的流程和意图, 而且当你几个月后再回过头来看自己的代码时仍能帮你很好的理解。 注释并没有强制规定的格式,但是我们建议以下的形式。
DocBlock风格的注释,写在类、方法和属性定义的前面,可以被 IDE 识别:
/** * Super Class * * @package Package Name * @subpackage Subpackage * @category Category * @author Author Name * @link http://example.com */class Super_class {
/** * Encodes string for use in XML * * @param string $str Input string * @return string */function xml_encode($str)
/** * Data for class manipulation * * @var array */public $data = array();
单行注释应该和代码合在一起,大块的注释和代码之间应该留一个空行。
// 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);
类的常量中所有字母都必须大写,词间以下划线分隔。 参照以下代码:
PHP所有 关键字必须全部小写。
常量 true、 false和 null也必须全部小写。
逻辑操作符
不要使用 ||操作符,它在一些设备上看不清(可能看起来像是数字 11), 使用 &&操作符比使用 AND要好一点,但是两者都可以接受。 另外,在 !操作符的前后都应该加一个空格。
对返回值进行比较以及类型转换
有一些 PHP 函数在失败时返回 FALSE ,但是也可能会返回 "" 或 0 这样的有效值, 这些值在松散类型比较时和 FALSE 是相等的。所以当你在条件中使用这些返回值作比较时, 一定要使用严格类型比较,确保返回值确实是你想要的,而不是松散类型的其他值。
在检查你自己的返回值和变量时也要遵循这种严格的方式,必要时使用 === 和 !== 。
文件中的空格
PHP 起始标签的前面和结束标签的后面都不要留空格。
一个类一个文件
除非几个类是 紧密相关的,否则每个类应该单独使用一个文件。
空格
函数和控制结构必须使用 Allman 样式括起来
字符串使用单引号引起来,当字符串中有变量时使用双引号,并且使用大括号将变量包起来。 另外,当字符串中有单引号时,也应该使用双引号,这样就不用使用转义符。
'My String'"My string {$foo}""SELECT foo FROM bar WHERE baz = 'bag'"
已抢186432个
抢已抢67239个
抢已抢352891个
抢已抢666978个
抢已抢121965个
抢已抢23003个
抢