WEB开发网
开发学院CMS教程phpcms PHPCMS开发文档里看到PHP编码规范 阅读

PHPCMS开发文档里看到PHP编码规范

 2009-10-17 05:33:00 来源:WEB开发网   
核心提示:case 2: echo ‘var is 2’; break;default: echo ‘var is neither 1 or 2’; break;}}else{switch ($str){case ‘abc’:$result = &lsquo

case 2: echo ‘var is 2’; break;

default: echo ‘var is neither 1 or 2’; break;

}

}

else

{

switch ($str)

{

case ‘abc’:

$result = ‘abc’;

break;

default:

$result = ‘unknown’;

break;

}

}

4.3.3. 运算符、小括号、空格、关键词和函数

每个运算符与两边参与运算的值或表达式中间要有一个空格,唯一的特例是字符连接运算符号两边不加空格;

左括号“(” 应和函数关键词紧贴在一起,除此以外应当使用空格将“(”同前面内容分开;

右括号“)”除后面是“)”或者“.”以外,其他一律用空格隔开它们;

除字符串中特意需要,一般情况下,在程序以及HTML中不出现两个连续的空格;

任何情况下,PHP程序中不能出现空白的带有TAB或空格的行,即:这类空白行应当不包含任何TAB或空格。同时,任何程序行尾也不能出现多余的TAB或空格。多数编辑器具有自动去除行尾空格的功能,如果习惯养成不好,可临时使用它,避免多余空格产生;

每段较大的程序体,上、下应当加入空白行,两个程序块之间只使用1个空行,禁止使用多行。

程序块划分尽量合理,过大或者过小的分割都会影响他人对代码的阅读和理解。一般可以以较大函数定义、逻辑结构、功能结构来进行划分。少于15行的程序块,可不加上下空白行;

说明或显示部分中,内容如含有中文、数字、英文单词混杂,应当在数字或者英文单词的前后加入空格。

根据上述原则,以下举例说明正确的书写格式:

$result = (($a + 1) * 3 / 2 + $num)).’Test’;

$condition ? func1($var) : func2($var);

$condition ? $long_statement

: $another_long_statement;

if ($flag)

{

//Statements

//More than 15 lines

}

Showmessage(‘请使用 restore.php 工具恢复数据。’);

4.3.4. 函数定义

l 参数的名字和变量的命名规范一致;

l 函数定义中的左小括号,与函数名紧挨,中间无需空格;

l 开始的左大括号另起一行;

l 具有默认值的参数应该位于参数列表的后面;

l 函数调用与定义的时候参数与参数之间加入一个空格;

l 必须仔细检查并切实杜绝函数起始缩进位置与结束缩进位置不同的现象。

例如,符合标准的定义:

function authcode($string, $operation, $key = '')

{

if($flag)

{

//Statement

}

//函数体

}

不符合标准的定义:

function authcode($string,$operation,$key = '') {

//函数体

}

4.3.5. 引号

PHP中单引号和双引号具有不同的含义,最大的几项区别如下:

单引号中,任何变量($var)、特殊转义字符(如“t r n”等)不会被解析,因此PHP的解析速度更快,转义字符仅仅支持“’”和“\”这样对单引号和反斜杠本身的转义;

双引号中,变量($var)值会代入字符串中,特殊转义字符也会被解析成特定的单个字符,还有一些专门针对上述两项特性的特殊功能性转义,例如“$”和“{$array[‘key’]}。这样虽然程序编写更加方便,但同时PHP的解析也很慢;

数组中,如果下标不是整型,而是字符串类型,请务必用单引号将下标括起,正确的写法为$array[‘key’],而不是$array[key],因为不正确的写法会使PHP解析器认为key是一个常量,进而先判断常量是否存在,不存在时才以“key”作为下标带入表达式中,同时出发错误事件,产生一条Notice级错误。

因此,在绝大多数可以使用单引号的场合,禁止使用双引号。依据上述分析,可以或必须使用单引号的情况包括但不限于下述:

l 字符串为固定值,不包含“t”等特殊转义字符;

l 数组的固定下标,例如$array[‘key’];

l 表达式中不需要带入变量,例如$string = ‘test’;,而非$string = “test$var”;

例外的,在正则表达式(用于preg_系列函数和ereg系列函数)中,phpcms全部使用双引号,这是为了人工分析和编写的方便,并保持正则表达式的统一,减少不必要的分析混淆。

数据库SQL语句中,所有数据都不得加单引号,但是在进行sql查询之前都必须经过intval函数处理;所有字符串都必须加单引号,以避免可能的注入漏洞和SQL错误。正确的写法为:

$catid = intval($catid);

SELECT * FROM phpcms_member WHERE username=’$_username’ AND catid=$catid;

所有数据在插入数据库之前,均需要进行addslashes()处理,以免特殊字符未经转义在插入数据库的时候出现错误。phpcms中如果已经引入了文件 common.inc.php,则所有通过 GET, POST, FILE,取得的变量默认情况下已经使用了addslashes()进行了转义,不必重复进行。如果数据处理必要(例如用于直接显示),可以使用 stripslashes() 恢复,但数据在插入数据库之前必须再次进行转义。

缓存文件中,一般对缓存数据的值采用 addcslashes($string, ''\')进行转义。

4.3.6.

4.4.命名原则

命名是程序规划的核心。古人相信只要知道一个人真正的名字就会获得凌驾于那个人之上的不可思议的力量。只要你给事物想到正确的名字,就会给你以及后来的人带来比代码更强的力量。

名字就是事物在它所处的生态环境中一个长久而深远的结果。总的来说,只有了解系统的程序员才能为系统取出最合适的名字。如果所有的命名都与其自然相适合,则关系清晰,含义可以推导得出,一般人的推想也能在意料之中。

上一页  1 2 3 4 5 6  下一页

Tags:PHPCMS 开发 文档

编辑录入:爽爽 [复制链接] [打 印]
赞助商链接