PHP_代码风格规范.docx

PHP代码风格 概述 本文档指定基本的 php编码风格约定。 1.文档历史 更新的概要注意日期 作者 更新的概要 注意 2010-03-15 Alle n 备注 本文档中风格和格式的用法 类别名称 ?项目标题 说明文字 蓝色的代码示例是正确的 红色的代码示例是错误的 //这是注释 目录 Coding Style Conventions General Rules Formatting Naming Documentation Programming 1. 3... 4 .. 9 1 . 3 ... 4 .. 9 11 . 14 17 1.通用规则 原则 ?简单，清楚，完整性，一致性 ?鲁棒性 ?第一次就要做正确 PHP PHP PHP PHP 2. 格式 ?文本文件的编码使用’UTF-8' ?文本文件换行定界符使用'\n' (Unix类型) 当我们创建和编辑文件时，使用 Unix换行('\n')代替DOS换行('\r\n'); ?约定一个tab等于四个空格 tab在不同的平台下表现不同，对于 tab而言总是使用空格代替他 设置所有编辑器中的tab键等于四个空格 ? PHP标签：总是使用'<?php ',丢弃'<? ?> ' ?缩进:在PHP中的每个缩进都使用tab等于四个空格 ?使用空行分隔逻辑块 ?行末尾不允许有空格 ? 使用"else if "代替"elseif " ?对于'if', 'while ', 'for',等逻辑块使用括号括起，哪怕只有一行逻辑，便于阅 读 //错误的示例 while (...) bar(); //正确的示例 while (...) { bar(); } ?不允许在新行上写开口括【左括号】 不要在新的一行写开口括号【左括号】 ；请在行尾写'{'. //错误的示例 if (...) { } else { //正确的示例 if (...) { } else { //错误的示例 fun cti on test() { } //正确的示例 fun cti on test() { } 在表达式、语句、PHP关键字等两边各使用一个空格空开 //错误的示例 if(…){ //正确的示例 if (...) { //错误的示例 $var= ' aaa ' //正确的示例 $var = aaa 函数应该遵循下列规则 函数名字与参数列表的开括号之间没有空格，他们两个看做一整体，这个整体的两边需要有 各有一个空格，然后参数列表里，每个参数相对前一个参数需要有一个空格。 //错误的示例 fun cti on up dateRecords ($table,$ parameters,$c on diti on s){ //正确的示例 fun cti on up dateRecords($table, $p arameters, $con diti ons) { 参数列表中有默认值的参数应放在参数列表最后面 使用括号括起操作优先级非常清楚地语句，循环语句除外 //错误的示例 if ($cou nt + 1 > MAX_COUNT) { //正确的示例 if (($cou nt + 1) > MAX_COUNT) { //错误的示例 if($rss["ads pacetyp e"] == 3 && $rss["alig nmen t"] == 1) {} //正确的示例if((3 //正确的示例 if((3 == $rss[ adspacetype ' ]) && (1 == $rss[ alignment ‘ ])) {} 字符串:普通的字符串使用单引号('),如果字符串中需要解析PHP变量时使用 双引号("") 在PHP中双引号(")解析，单引号(')不解析.在双引号字符串上 PHP要做额外的工作，所以 他们两个有一些微妙的性能差别。即便双引号中的变量可以被解释，但也只限于简单的变量 名，当使用复杂的名字时，必须将变量独立出去，如一个变量组成 2维数组 这样的句子不能被正确解释，复杂的变量名，可以将变量用大括号括起来 这样的句子可以被正确解释 //错误的示例 $errorMessage = "The URL is in correct!"; //错误的示例[复杂变量] $errorMessage = "The URL is $a[$b][$c] in correct!"; //可已接受的，但不是最好的 $associativeArray[" name_$x"]; $var = "My Stri ng $a"; //最好的 $associativeArray[' name']; $var = 'My Stri ng'; $var2 = 'Very... l on g... stri ng...