http://67.220.92.14/forum/inde 讲的非常不错的PHP编码规范第1/3页

php中文网

发布时间：2016-07-29 08:37:19

2975人浏览过

来源于php中文网

原创

注：这是从phpcms开发文档里看到编码规范，虽名为phpcms的开发规范，但我觉得所有的php编程都该如此。写了那么多php，很多编码对照这规范都感觉欠缺很多，今后一定要对照纠正。
phpcms 编码规范
1. 引言…. 2
2. 适用范围…. 2
3. 标准化的重要性和好处…. 3
4. php编码规范与原则…. 3
4.1. 代码标记… 3
4.2. 注释… 3
4.3. 书写规则… 4
4.3.1. 缩进… 4
4.3.2. 大括号{}、if和switch. 4
4.3.3. 运算符、小括号、空格、关键词和函数… 5
4.3.4. 函数定义… 6
4.3.5. 引号… 6
4.3.6. 多语言问题… 7
4.4. 命名原则… 8
4.4.1. 变量、对象、函数名… 8
4.4.2. 常量… 8
4.5. 变量的初始化与逻辑检查… 8
4.6. 安全性… 9
4.7. 兼容性… 9
4.8. 代码重用… 10
4.9. 其他细节问题… 10
4.9.1. 包含调用… 10
4.9.2. 错误报告级别… 11
5. 数据库设计…. 11
5.1. 字段… 11
5.1.1. 表和字段命名… 11
5.1.2. 字段结构… 11
5.2. sql语句… 12
5.3. 性能与效率… 13
5.3.1. 定长与变长表… 13
5.3.2. 运算与检索… 13
5.3.3. 结构优化与索引优化… 14
5.3.4. 查询优化… 14
5.3.5. 兼容性问题… 16
6. 模板设计…. 16
6.1. 代码标记… 16
6.2. 书写规则… 16
6.2.1. html. 16
6.2.2. 变量… 16
6.2.3. 语言元素… 17
6.2.4. 缩进… 17
7. 文件与目录…. 17
7.1. 文件命名… 17
7.2. 目录命名… 18
7.3. 空目录索引… 18
1. 引言
本规范由编程原则组成，融合并提炼了开发人员长时间积累下来的成熟经验，意在帮助形成良好一致的编程风格。以达到事半功倍的效果，如果有需要本文档会不定期更新。
版权：陕西玖肆陆陆网络科技有限公司，保留所有权利
最后更新日期：年11月20日 2006
2. 适用范围
如无特殊说明，以下规则要求完全适用于phpcms项目，同时也可大部分适用于公司其他php项目。
3. 标准化的重要性和好处
当一个软件项目尝试着遵守公共一致的标准时，可以使参与项目的开发人员更容易了解项目中的代码、弄清程序的状况。使新的参与者可以很快的适应环境，防止部分参与者出于节省时间的需要，自创一套风格并养成终生的习惯，导致其它人在阅读时浪费过多的时间和精力。而且在一致的环境下，也可以减少编码出错的机会。缺陷是由于每个人的标准不同，所以需要一段时间来适应和改变自己的编码风格，暂时性的降底了工作效率。从使项目长远健康的发展以及后期更高的团队工作效率来考虑暂时的工作效率降低是值得的，也是必须要经过的一个过程。标准不是项目成功的关键，但可以帮助我们在团队协作中有更高的效率并且更加顺利的完成既定的任务。
1. 程序员可以了解任何代码，弄清程序的状况
2. 新人可以很快的适应环境
3. 防止新接触php的人出于节省时间的需要，自创一套风格并养成终生的习惯
4. 防止新接触php的人一次次的犯同样的错误
5. 在一致的环境下，人们可以减少犯错的机会
6. 程序员们有了一致的敌人
4. php编码规范与原则
4.1.代码标记
php程序可以使用或来界定 php 代码，在html页面中嵌入纯变量时，可以使用这样的形式。
近年来php开发组一直倡导代码规范化和标准化，未来版本php可能会开始不建议使用甚至取消和这种速记形式，因此为了加强程序兼容性，在发布之前我们将统一把
4.2.注释
注释是对于那些容易忘记作用的代码添加简短的介绍性内容。请使用 c 样式的注释“/* */”和标准 c++ 注释“//”。
程序开发中难免留下一些临时代码和调试代码，此类代码必须添加注释，以免日后遗忘。所有临时性、调试性、试验性的代码，必须添加统一的注释标记“//debug”并后跟完整的注释信息，这样可以方便在程序发布和最终调试前批量检查程序中是否还存在有疑问的代码。例如：
$num = 1;
$flag = true; //debug 这里不能确定是否需要对$flag进行赋值
if(empty($flag)) {
//statements
}
4.3.书写规则
4.3.1. 缩进
每个缩进的单位约定是一个tab(8个空白字符宽度)，需每个参与项目的开发人员在编辑器(ultraedit、editplus、zend studio等)中进行强制设定，以防在编写代码时遗忘而造成格式上的不规范。
本缩进规范适用于php、javascript中的函数、类、逻辑结构、循环等。
4.3.2. 大括号{}、if和switch
首括号与关键词同行，尾括号与关键字同列；
if结构中，if和elseif与前后两个圆括号同行，左右各一个空格，所有大括号都单独另起一行。另外，即便if后只有一行语句，仍然需要加入大括号，以保证结构清晰；
switch结构中，通常当一个case块处理后，将跳过之后的case块处理，因此大多数情况下需要添加break。break的位置视程序逻辑，与case同在一行，或新起一行均可，但同一switch体中，break的位置格式应当保持一致。
以下是符合上述规范的例子：
if ($condition)
{
switch ($var)
{
case 1: echo ‘var is 1'; break;
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 工具恢复数据。');