PHP_程序编码规范PHP_程序编码规范.doc

PHP 程序编码规范 Any violation to this guide is allowed if it enhances readability. 所有的代码都要变成可供他人容易阅读的 良好的代码书写习惯 + 良好的注释习惯 + PhpDocumentor = 程序说明书 整理日期:2014-05-06 参考修改自: .NET 编程规范 华为编程规范 JavaScript 程序编码规范(cloudwater 译) PHP 开发规范(未知出处) PHP Coding Standard(Fredrik Kristiansen / DB Medialab) 等 前言 第 1 章 排版规则 1.1 缩进 1.2 空格规则 1.2.1 逻辑运算符前后必须加空格 1.2.2 多个参数分隔时必须加空格 1.2.3 语法关键字后必须加空格 1.2.4 字符串和变量连接规则 1.3 换行 1.3.1 较长的语句(80 字符) 第 2 章 命名规范 2.1 变量命名 2.1.1 局部变量 2.1.2 全局变量命名 2.1.3 静态变量命名 2.1.4 引用变量和函数返回引用 2.1.5 临时变量命名 2.1.6 方法中参数命名 2.2 命名定义/ 全局常量 2.3 类命名 2.3.1 接口命名原则 2.3.2 Exception 命名原则 2.3.3 类库命名 2.3.4 方法命名 2.3.5 方法/函数命名修饰 2.3.6 类属性命名 2.3.7 私有属性与私有方法命名 2.3.8 对象命名 2.4 缩写词不要全部使用大写字母 2.5 函数命名 第 3 章 版式规则 3.1 语义分隔 3.2 圆括号规则 PHP 程序编码规范 3.3 方法/函数 3.4 关键字 3.4.1 if 语句 3.4.2 for 语句 3.4.4 do 语句 3.4.5 switch 语句 3.4.6 try 语句 3.4.7 return 语句 第 4 章 编程规范 4.1 数组定义规则 4.2 不要采用缺省方法测试非零值 4.3 通常避免嵌入式的赋值 4.4 布尔逻辑类型 4.5 别在对象架构函数中做实际的工作 4.6 switch 格式 4.7 Continue 和 Break 4.8 ? : 4.9 其他杂项 4.9.1 类定义文件中,定义体之外不得出现诸如 echo、print 等输出语句; 4.9.2 在 HTML 网页中尽量不要穿插 PHP 代码 4.9.3 没有含义的数字 4.9.4 PHP 文件扩展名 4.9.5 总是将恒量放在等号/不等号的左边 4.10 SQL 规则 4.10.1 输出网页的页面不出现 SQL 语句 4.10.2 进行 SQL 执行的数据必须进行有效性检测 第 5 章 注释规则 5.1 一般规则 5.2 方法/函数注释 5.3 类注释 5.4 记录所有的空语句 5.5 用 if (0)来注释外部代码块 5.6 版权信息 第 1 章 排版规则 1.1 缩进 缩进对齐统一使用一种方式;只用 4 个空格或者只用 TAB。 说明: 根据实际使用的环境来决定。一些编辑器自动转换 TAB 为 4 个空格的距离,但有些也会转换为 8 个空格。 块开头对齐赋值: $book_name = ;//书名 $new_book_name = ;//新书名 $new_book_page_count = 0 ;//新书页计数 说明:一般在函数的开头把所有用到的内部变量都初始化一次,这样可以防止程序的未定义错误,并且 对函数内部变量有个直观的一览。适用于定长字体。 1.2 空格规则 空格应在以下情况时使用: ? 跟在((左括号)后面的关键字应被一个空格隔开。 while (true) { 函数名与左括号之间不应该有空格。这能帮助区分关键字和函数调用。 function myfun() { 所有的二元操作符,除了左括号和左方括号应用空格将其与操作数隔开。 一元操作符与其操作数之间不应有空格,除非操作符是个单词,比如 typeof。 每个在控制部分,比如 for 语句中的; (分号)后须跟一个空格。 for ($i = 0; $i 10; $i++) { 每个, (逗号)后应跟一个空格。