PHP系列直播:从代码细节聊一聊如何成为一名优秀的工程师

2019-03-20 08:27:02 织梦安装使用
  • 文章介绍
云栖社区


主讲人


周梦康(楚松)  点击关注专家

https://yq.aliyun.com/users/dy6hwsruw6kbe

阿里云资深研发工程师,《深入 PHP 内核》作者之一



内容提要


从代码细节聊一聊如何成为一名优秀的工程师


  • 你的代码语意清晰吗?

  • 你的代码足够健壮吗?

  • 你的代码运行安全吗?

  • 你的代码考虑性能吗?


直播时间


2019年3月12日  19:30


直播地址


PHP技术进阶钉群:http://uee.me/aMsFp


详情如下:



更多内容


更多内容可关注PHP技术进阶云栖号(https://yq.aliyun.com/teams/405), 获取第一手技术资料


阿里开发者技术交流钉钉群的全向图【2019年】

https://yq.aliyun.com/articles/690084


好的语义表达是团队协作中高效迭代的润滑剂,好的语义表达是线上未知代码问题排查的指南针。


不要让其他人读不懂你的代码,其他人可能就是一周后的你。时刻以“如果你写的这段代码出现故障,一个陌生人接手你的代码需要多久能处理完这个bug”来监督自己。


日常中应该多多刻意提升自己语义表达,百利而无一害。那么我们应该从哪些细节去做好语义表达呢?



以下代码全为我的艺术创作,不属于任何实际项目


命名


案例1




案例2



如果仅仅有这个函数名和参数名,谁能猜到参数的意义呢?



案例3




案例4


假如业务代码里有这些类



而我们查询数据库发现



这样我们根据业务代码就非常不方便找到对应的表,而且其他人接手我们项目的时候,也会摸不着头脑。或者说这可能是三个人三次迭代开发造成的,那么他们彼此都没有去参考前面人的命名规则。


来自灵魂的拷问



注释


说完命名,下面说下注释。注释里还有什么学问?Are you kidding me?
一个数组对象成员,你知道怎么写吗?
类的魔术方法调用的注释,你知道怎么写吗?


对象数组






@method 的使用




@deprecated 使用




注释其他注意事项


注释解释张冠李戴,方法名更新,方法的功能业务注释没更新;复制别人的代码把 @author 信息也复制过来了,错误了还要把锅甩给别人。


注释更多参考 

http://manual.phpdoc.org/HTMLframesConverter/default/


函数、方法


案例1


先说明一句,不好的代码不妨碍它成为一个优秀的软件。PHP MySQL 烂代码多的去了。
找到一个开源软件里面的代码,功能非常抢到,但是这个方法内容太多,一些不足点我标注出来了。



案例2


拿上面我举例子,还记得下面这种图吗?



优化方案1



优化方案2





案例3


这还是函数吗?(不仅仅是语义,属于错误)



$startId和$lastId两个参数重复


案例4


尽量减少参数引用



案例5


参数类型明确,返回值类型明确,不要出现 mixed。这个我直接拿官方的函数来举例,对权威也要有怀疑的眼光。纯属个人看法。



案例6



上面例子中你会发现这个addUser写得不想一个函数(方法)而像一个远程api接口。而且在右边的代码中需要每次使用的时候都要用is_array来判断。这是非常不友好的语义表达。PHP Java 这样的高级语言有异常,我们要善用异常。



好的语义表达是团队协作中高效迭代的润滑剂,好的语义表达是线上未知代码问题排查的指南针。这篇博客到这里就结束了,不知道你是否有一些收获呢?



更多精彩


阿里云开年Hi购季满返活动火热进行中


三七女生节,解密阿里女程序员们的代码诗!

实时计算最佳实践:基于表格存储和Blink的大数据实时计算


Dubbo Mesh 在闲鱼生产环境中的落地实践

如果觉得本文还不错,点击好看一下!

    阅读原文

    发送中

    阅读原文

    上一篇:html5点击按钮酷炫云雾动画弹出文字..

    下一篇:没有了

    相关文档推荐

    精品模板推荐

    专业的织梦模板定制下载站,在线购买后即可下载!

    商业源码

    跟版网模板,累计帮助5000+客户企业成功建站,为草根创业提供助力!

    立刻开启你的建站之旅
    
    QQ在线客服

    服务热线

    织梦建站咨询