php编码规范
发布日期:2025-05-04 20:14:53 浏览次数:2 分类:精选文章

本文共 1056 字,大约阅读时间需要 3 分钟。

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

一、编程规约

a、命名规约

变量命名规则:

  • 未知类型时用大写字母开头
  • 字符串:$sMyName
  • 数组:$aMyCard
  • 二维数组:$aaMyCard
  • 对象:$oMyObject
  • 资源:$resource
  • 布尔值:$flag
  • 整型:$iMyNumber
  • 浮点型:$fMyMoney

类名命名规则:

  • 类名采用UpperCamelCase风格
  • 例外:PDO等领域模型相关命名
  • 正例: MarcoPolo, UserDO, XmlService, TcpUdpDeal, TaPromotion
  • 反例: macroPolo, UserDo, XMLService, TCPUDPDeal, TAPromotion

常量命名规则:

  • 全部大写,单词间用下划线隔开
  • 例:MAX_STOCK_COUNT

数据库命名规则:

  • 表名和字段用下划线连接单词
  • 例:blog_user_info
  • 部分缩写:image(img),string(str),database(db),count(cnt),temporary(tmp),password(pwd),message(msg)

注释规范:

  • 注释应描述为什么,而非做什么
  • SQL尽量避免直接写在函数内,建议先赋值再调用函数

b、格式规约

  • 大括号使用约定:

    • 空大括号写成 {}
    • 非空大括号:
      • 左大括号前不换行
      • 左大括号后换行
      • 右大括号前换行
      • 右大括号后若有else等代码则不换行
  • 括号使用规范:

    • 左括号和后一个字符之间不出现空格
    • 右括号和前一个字符之间也不出现空格
    • 示例:if ($a != $b) {}
  • 保留字与括号间必须加空格:

    • 示例:if ( $a != $b ) {}
  • 运算符两侧必须加空格:

    • 包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等
    • 示例:$a = $b + $c
  • 缩进规范:

    • 使用4个空格,禁止使用tab字符
    • IDEA设置:tab为4个空格时,勿勾选Use tab character
    • Eclipse设置:勾选insert spaces for tabs
  • 单行字符数限制:

    • 不超过120个字符
    • 超出需换行,换行原则:
      • 第二行相对第一行缩进4个空格
      • 第三行及以后不再继续缩进
      • 运算符与下文一起换行
  • 二、示例引用

    • 公共类命名:public class OrderFactory
    • 代理类命名:public class LoginProxy
    • 观察者模式类名:public class ResourceObserver
    上一篇:PHP编码规范-PSR1、psr2 /psr3 psr4
    下一篇:php编写TCP服务端和客户端程序

    发表评论

    最新留言

    表示我来过!
    [***.240.166.169]2026年06月19日 02时58分18秒