php编码规范

这篇博客详细介绍了PHP的编码规范,参照了阿里巴巴的JAVA编码规范,包括命名规约、格式规约、面向对象编程原则、控制语句的使用、MySQL数据库操作规范以及安全方面的最佳实践。
摘要由CSDN通过智能技术生成

php编码规范(参考阿里巴巴JAVA编码规范)

一、编程规约

a、命名规约

变量:不知道类型的用大写字母开头。否则:
    字符串 = $sMyName
    数组 = $aMyCard	二维数组 = $aaMyCard
    对象 = $oMyObject
    资源 = $resource
    布尔值 = $flag
    整型 = $iMyNumber
    浮点型 = $fMyMoney

类名命名规则 = ‘i’ + 接口命名规则   例如:MyClass iMyInterface

数据库中的所有内容命名不得有大写字母。表名和字段用下划线连接单词,例如:blog_user_info。

部分缩写:
image = img
string = str
database = db
count = cnt
temporary = tmp
password = pwd
message = msg

代码注释应该描述为什么,而不是做什么。

SQL尽量不要写在函数里面,而是先赋给变量,再交给函数。
1.代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
反例: name / __name / $Object / name / name$ / Object$

2.代码中的命名严禁使用拼音与英文混合的方式。
正例: alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。

3. 【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:(领域模型
的相关命名)PDO 等。
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

4.【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从
驼峰形式。

5. 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
正例: MAX_STOCK_COUNT

6. 【强制】类名特性应在结尾出表明:异常类命名使用 Exception 结尾;测试类
命名以它要测试的类的名称开始,以 Test 结尾。

7. 【强制】杜绝完全不规范的缩写,避免望文不知义。
反例: AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类
随意缩写严重降低了代码的可阅读性。

. 【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。
正例:public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

b、格式规约

1. 【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果
是非空代码块则:
1) 左大括号前不换行。
2) 左大括号后换行。
3) 右大括号前换行。
4) 右大括号后还有 else 等代码则不换行;表示终止右大括号后必须换行。

2. 【强制】 左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空
格。详见第 5 条下方正例提示。

3. 【强制】if/for/while/switch/do 等保留字与左右括号之间都必须加空格。

4. 【强制】任何运算符左右必须加一个空格。
说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。

5. 【强制】缩进采用 4 个空格,禁止使用 tab 字符。
说明:如果使用 tab 缩进,必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时,
请勿勾选 Use tab character;而在 eclipse 中,必须勾选 insert spaces for tabs。

正例: (涉及 1-5 点)
public static function student($id){
    //四个空格
    $id = 12;
    if ( $id == 1 ){
        echo 'no';
    } else {
        echo 'yes';
    }
}

6. 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:
1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。
2) 运算符与下文一起换行。
3&#
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值