PHP 编程规范

关于PHP编程的规范 自己总结出的一些规范,方便大家参考 ,主要从代码版本管理规范以及代码自身的规范。

代码版本管理规范:

基本原则就是只管理代码部分,不管配置文件,第三方(composer),编译生成的中间文件,保证每一次提交都是有效提交。

  1. 配置文件不受版本管理
    像代码里面的配置文件、数据库配置文件、环境配置文件等,这些不应该放在版本管理里面,每个人clone代码下来的时候自己维护自己的环境,这样也方便部署的时候不会因为这些而引起异常。

  2. 上传描述与上传内容一致
    每次push 代码的时候都必须要有log 日志,日志的内容与push的内容(修改,新增)是一致的,这样方便以后回归版本的时候能够通过日志信息定位到哪一次提交。

  3. 上传代码独立性、完整性
    保证第一次push都是完整的,保证其它用户update的时候不会出现问题。

  4. 没有修改的文件不要上传(只修改了空行)
    update的时候保证每个文件都有修改。

  5. 不需要的代码,直接删除,保持代码干净
    不需要的代码以后可以通过log日志来查看;
    不需要的代码会让人心情不好;
    不需要的代码后面的人不敢删。

  6. 开发developer分支
    针对于长期项目,至少两个分支,一个分支用于发布,一个分支用于开发 。

代码规范原则

  1. 模块职责范围
    Controller负责获取请求,返回数据;
    Doctrine负责各种业务操作;
    Repository 负责数据库相关的操作,filter只负责重组数据,不负责产生新的数据。

  2. 快速失败
    先处理错误情况,再处理正确情况。

  3. 高内聚,低耦合

  4. Once and Only Once
    如果出现同段代码(同结构代码)多个地方出现,肯定会可以重构。

  5. 每个函数不超过屏幕长度
    函数不超过30行左右,太长了不容易读者查看,思路容易断。

  6. 块代码
    通过空行,按思路把函数分为几块。

  7. public private
    不要乱用,函数对外public 越少越不容易犯错。

  8. 参数越少越好

  9. 代码集体所有制
    团队每个人都要对代码负责,即使不是自己写的代码。

  10. 自解释的代码
    命名规范,保证每个命名与自己的职责一致,可以参考公司博客这篇文章

  11. 第三方组件接口
    单独出来,用接口来实现。

  12. 对高质量代码的渴望
    有种感觉就是不改不舒服

  13. 所有库查询以传参的形式进行
    sql 语句查询,安全性考虑。

  14. FunmiBundle
    单独Bundle。

  15. 命名规则

    1. 数据库驼峰命名
    2. 是:1,否 0, 男1, 女0
    3. bool 变量命名,isXX, canXX
  16. 开发使用app_dev.php , 部署没有app.php

  17. 不要有magic number

    1. i , j => **index
    2. pic1, pic2 => xxPic;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,826评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,968评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,234评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,562评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,611评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,482评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,271评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,166评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,608评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,814评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,926评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,644评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,249评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,866评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,991评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,063评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,871评论 2 354

推荐阅读更多精彩内容