注:这是从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. 标准化的重要性和好处 当一个软件项目尝试着遵守公共一致的标准时,可以使参与项目的开发人员更容易了解项目中的代码、弄清程序的状况。使新的参与者可以很快的适应环境,防止部分参与者出于节省时间的需要,自创一套风格并养成终生的习惯,导致其它人在阅读时浪费过多的时间和精力。而且在一致的环境下,也可以减少编码出错的机会。缺陷是由 |