PHP开发规范.docx

目录
1、编写目的 3
2、整体要求 4
3、安全规范 5
、包含文件 5
、命名规则 5
、存放规则 5
、安全规则 5
、一些针对PHP的规则 5
、其它处理规则 5
、输入参数处理 5
、操作大HTML文本 5
4、编码规范 6
、命名规范 6
、变量命名 6
、类命名 6
、方法或函数 6
、缩写词 6
、数据库表名 6
、数据库字段 6
、书写规则 6
、代码缩进 6
、大括号{}书写规则 6
、小括号()和函数、关键词等 6
、=符号书写 6
、if else swith for while等书写 6
、类的构造函数 6
、语句断行 6
、数字 6
、判断 6
、避免嵌入赋值 6
、错误返回检测规则 6
、程序注释 6
、程序头注释块 6
、类的注释 6
、函数和方法的注释 6
、变量或者语句注释 6
、其它规范 6
、PHP代码标记 6
、程序文件名、目录名 6
、PHP项目通常的文件目录结构 6
、PHP和HTML代码的分离问题 6
、PHP项目开发中的程序逻辑结构 6
5、特定环境下PHP编码特殊规范 7
、变量定义 7
、引用的使用 7
、变量的输入输出 7
1、编写目的
    为了更好的提高技术部的工作效率,保证开发的有效性和合理性,并可最大程度的提高程序代码的可读性和可重复利用性,指定此规范。开发团队根据自己的实际情况,可以对本规范进行补充或裁减。
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 的功能是分散到不同的页面使用的话,就不建议封装。
、存放规则
    一般包含文件不需要直接暴露给用户,所以应该放在 Web Server 访问不到的目录,避免因为配置问题而泄露设置信息。
、安全规则
    请参考产品安全检查表。
输入和输出:
检查是否做了HTML代码的过滤
可能出现的问题:如果有人输入恶意的HTML代码,会导致窃取cookie, 产生