PHP 开发规范.doc

目录1、编写目的 32、整体要求 43、安全规范 、包含文件 、命名规则 、存放规则 、安全规则 、一些针对PHP的规则 、其它处理规则 、输入参数处理 、操作大HTML文本 54、编码规范 、命名规范 、变量命名 、类命名 、方法或函数 、缩写词 、数据库表名 、数据库字段 、书写规则 、代码缩进 、大括号{}书写规则 、小括号()和函数、关键词等 、=符号书写 、ifelseswithforwhile等书写 、类的构造函数 、语句断行 、数字 、判断 、避免嵌入赋值 、错误返回检测规则 、程序注释 、程序头注释块 、类的注释 、函数和方法的注释 、变量或者语句注释 、其它规范 、PHP代码标记 、程序文件名、目录名 、PHP项目通常的文件目录结构 、PHP和HTML代码的分离问题 、PHP项目开发中的程序逻辑结构 65、特定环境下PHP编码特殊规范 、变量定义 、引用的使用 、变量的输入输出 71、编写目的    为了更好的提高技术部的工作效率,保证开发的有效性和合理性,并可最大程度的提高程序代码的可读性和可重复利用性,指定此规范。开发团队根据自己的实际情况,可以对本规范进行补充或裁减。1、程序员可以了解任何代码,弄清程序的状况;2、新人可以很快的适应环境;3、防止新接触PHP的人出于节省时间的需要,自创一套风格并养成终生的****惯;4、防止新接触PHP的人一次次的犯同样的错误;5、在一致的环境下,人们可以减少犯错的机会;6、程序员们有了一致的敌人;2、整体要求    技术部php开发规范将参照PEAR的规范,基本采用PEAR指定的规范,在其基础上增加、修改或删除部分适合具体开发环境的规范。本规范只针对PHP开发过程中编码的规范,对于PHP开发项目中文件、目录、数据库等方面的规范,将不重点涉及。    本规范包含了PHP开发时程序编码中命名规范、代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、文件头的注释块、CVS标记、URL样例、常量命名等方面的规则。3、安全规范    当我们尝试编码时,很多时候不知道如何去让自己的代码变得安全一点,因为我们缺乏安全常识,安全常识的规范可以帮你杜绝一些日常的菜鸟黑客的攻击,却不能阻止骨灰级专家们的凌厉攻势,所以更高深的安全我们还得从其他途径学****包含文件    PHP文件的包含在通过PHP的函数引入文件时,由于传入的文件名没有经过合理的校验,从而操作了预想之外的文件,就可能导致意外的文件泄露甚至恶意的代码注入。、命名规则    提取出来具有通用函数的包含文件,,表明这是一个包含文件。    ,,。    如:、、、。    把以上文件以以下方式,:require_once('');require_once('');require_once('');require_once('');注意:是否需要封装到一个文件,视情况而定,如果每个inc的功能是分散到不同的页面使用的话,就不建议封装。、存放规则    一般包含文件不需要直接暴露给用户,所以应该放在WebServer访问不到的目录,避免因为配置问题而泄露设置信息。、安全规则    请参考产品安全检查表。输入和输出:检查是否做了HTML代码的过滤可能出现的问题:如果有人输入恶意的HTML代码,会导致窃取cookie,产生恶意登录表单,和破坏网站。检查变量做数据库操作之前是否做了escape可能出现的问题:如果一个要写入查询语句的字符串变量包含了某些特殊的字符,比如引号(',")或者分号(;)可能造成执行了预期之外的操作。建议采用的方法:使用mysql_escape_string()或实现类似功能的函数。检查输入数值的合法性可能出现的问题:异常的数值会造成问题。如果对输入的数值不做检