0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

从编写代码习惯谈工程师风格

工程师人生 来源:博客园 作者:等你归去来 2021-01-15 10:11 次阅读

引语:代码风格,是一个工程师长期以来养成的一些编写代码的习惯,其实并无绝对的好坏之分!但是,基本上可以这么说,一个有很好的代码风格的人,技术水平绝不会太低;反之,一个没有好的代码风格的人,技术水平也不会高到哪里去,即使是他已经有很多年的编程经验!因为,在业界有一个不成文的现象,那就是每个工程师都有一个追求技术提升,追求完美的梦!结果就是,随着个人技术水平的提高,风格也越来越成熟,而这个风格就体现着其个人水平!

本文以PHP语言的某微视角,说几个代码风格上的事,同理可推至其他语言,其他技术,甚至其他通用道理!

本文将以从面到线再到点的过程,讲述一些个人心得。仅供大家娱乐参考,如有不对,请多多指教。如有雷同,不胜荣幸!

本文就以一个虚拟项目作为线索吧!

1、面:所谓面,就是面对一个项目摆在眼前,怎样去部署大方向的问题的思路!准确的说,这里并不是真正地体现一个代码风格,而是一个做事风格!

风格1:1. 我需要需求书,书上怎么写,我就怎么做;2. 如果有一些未知的技术,尽量让需求上做一些让步,以减少开发难度;3. 找个牛逼的人,带着自己或其他人一起做;4. 时间是多久?

风格2:1. 我需要需求书,书上写的东西,清楚吗?有什么可要可不要的东西,有副作用吗?2. 大概需要什么样的辅助工具,在哪里可能会得到这些东西?3. 我怎样组建自己的技术团队?4. 时间是多久?5. 后期可能会有什么样的扩展?

2、线:所谓线,可以理解为流水线吧。就是怎样去完成这么一个计划,怎样调动生产?

风格1:1. 设计数据库; 2. 选择代码框架;3. 编码;

风格2:1. 设计服务架构;2. 模块细化;3. 设计数据库; 4. 选择代码框架;5. 编码;

3、 点:所谓点,其实才这里说的真正的代码风格,将着重说明一些。

风格1:任性,随意而为,没有规则!

风格2:着重讲解!

3.1. 不一定非要使用现有成熟框架,但是一定要有MVC的概念,基本要抛弃面向过程编程方式,采用面向对象,不任性;

3.2. 结合多种设计模式进行开发,如单例模式、工厂模式、抽象模式、观察者模式等等,这些都是成熟的概念,都要尽量多用!优雅,大气,效率,易读;

3.3. 类内部变量定义以权限放第一位,变量修饰符放第二位,以重要程度分先后,如 public static function fun1(){} ;类名与文件名有某种特定程度的相同,方便查看;类名统一首字母大写;私有变量或方法使用下划线开头以区分,如 private function _doCut($data);文件以最能体现其功能的单词命名,区分类型,如 IndexController.class.php, function.inc.php;

3.4. 文件内部使用统一命名方式,要么使用下划线方式命名,如 $get_child,$bind_value,要么使用驼峰式命名,如 $getChild,$bindValue;变量名尽量使用全名不要使用简写,如 getCategory不要简写成getCat;

3.5. 多个参数之间有逗号分隔时,逗号后要留一个空格如 fun($param1, $param2);运算符两边均有一个空格(数组对齐除外),如 $click = 123;

3.6. 避免使用global变量,尤其是有些不是公共初始化时产生的变量;

3.7. 杜绝函数内部include方法文件,因为这样很难找到真正起作用的方法,或者说方法混乱;

3.8. 使用自动加载方式,而非include方式;

3.9. 如果一定要包含文件,尽量使用include_once,require_once 避免一个文件被引入多次从而报错情况;

3.10. 对可能多次引用的全局变量,使用某类的静态方法进行获取,如 ConfigClass::get(‘main’, ‘field’); 对于数据库一类连接,使用静态变量,保存首次连接时打开的连接,从而多处使用DB实例时,仍然不会重复实例化,如 $db = ConfigClass::getDbInstance();

3.11. 多使用isset(), empty()等系统函数进行判断空操作而非 !$var, $var == null;

3.12. 对于使用两次以上方法,就应该去考虑提出到公用地方或者类中;

3.13. 数据查询先确认当前索引,配合写SQL,特别地方,一定加上注释;

3.14. 会使用文件锁,数据库锁,会使用缓存如 memcache, redis, mongodb等;

3.15. 会适当使用事务;

其实,好与不好,大家已早有定论,只是作个参考,罢了!

习惯,就好!

不要害怕今日的苦,你要相信明天,更苦!
编辑:hfy

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 工程师
    +关注

    关注

    59

    文章

    1571

    浏览量

    68545
  • PHP
    PHP
    +关注

    关注

    0

    文章

    453

    浏览量

    26706
收藏 人收藏

    评论

    相关推荐

    嵌入式工程师常用的开发工具有哪些?

    。 一、集成开发环境(IDE) IDE是嵌入式开发的核心工具之一。例如 Keil MDK,它支持多种微控制器架构,提供了强大的代码编辑、编译、调试功能。工程师可以在一个集成的环境中高效地编写
    发表于 12-20 15:29

    让单片机代码性能起飞的七大技巧

    单片机的程序比软开少一些,真正想编写出高效的代码,还是要积累很多年的。           在做研发工程师的10年里,我经历过几个公司,看过很多工程师写的
    的头像 发表于 11-16 10:21 593次阅读
    让单片机<b class='flag-5'>代码</b>性能起飞的七大技巧

    AIC3254的miniDSP编写代码编写C5502代码有什么区别?

    问题:AIC3254的miniDSP编写代码编写C5502代码有什么区别,执行速度和代码量来进行分析吧,谢谢回复
    发表于 11-06 07:22

    怎么样提高verilog代码编写水平?

    ,共同进步。 欢迎加入FPGA技术微信交流群14群! 交流问题(一) Q:怎么样提高verilog代码编写水平?Cpu 从事DFT工作。目前仅限于写一些简单模块。自学的话如何提高verilog编写水平
    发表于 09-25 20:05

    FPGA算法工程师、逻辑工程师、原型验证工程师有什么区别?

    的设计和实现。他们使用硬件描述语言(如 Verilog 或 VHDL)来编写代码,构建复杂的数字逻辑系统。工作包括模块的设计、功能的实现、时序的优化以及与其他硬件组件的接口设计等。 FPGA 原型验证工程师
    发表于 09-23 18:26

    探讨AI编写代码技术,以及提高代码质量的关键:静态代码分析工具Perforce Helix QAC &amp; Klocwork

    令软件开发人员夜不能寐的事情比比皆是。如今,他们最关心的问题不再是如何用自己喜欢的语言(C、C++、Erlang、Java 等)表达最新的算法,而是人工智能(AI)。 本文中,我们将介绍AI编写代码
    的头像 发表于 06-05 14:10 409次阅读

    扎心灵魂小拷问:有了AI编写代码之后,软件工程师会被AI取代吗?

    软件开发者们有很多让他们焦虑的事情。他们最担心的不再是如何用他们最喜欢的编程语言(C、C++、Erlang、Java等)表达最新的算法。相反,这种担忧正逐渐被人工智能(AI)所取代。 在这里,我们将探讨AI编写代码的过程,并回答这个问题:AI会取代程序员吗?
    的头像 发表于 05-24 19:17 664次阅读
    扎心灵魂小拷问:有了AI<b class='flag-5'>编写</b><b class='flag-5'>代码</b>之后,软件<b class='flag-5'>工程师</b>会被AI取代吗?

    嵌入式软件工程师和硬件工程师的区别?

    、调试和测试嵌入式软件,以确保其功能正常,性能优良。 * 文档编写:包括编写用户手册、维护文档等。 * 维护和更新:对现有的嵌入式软件进行维护和更新,以解决出现的问题和满足新的需求。 嵌入式软件工程师
    发表于 05-16 11:00

    嵌入式系统中C语言的编写规范

    最重要的一条规则 编写代码时最重要的一条规则是:检查周围的代码并尝试模仿它。 作为维护人员,如果收到的补丁明显与周围代码的编码风格不同,这是
    的头像 发表于 05-11 08:49 1156次阅读

    大厂电子工程师常见面试题#电子工程师 #硬件工程师 #电路知识 #面试题

    电子工程师电路
    安泰小课堂
    发布于 :2024年04月30日 17:33:15

    为何国外工程师偏爱使用for(;;)来实现MCU死循环?

    一位工程师发现,国外工程师在给demo在做死循环时用的是for(;;),而不是常用的while(1)。这仅仅是个人习惯的问题,还是有更深层次的含义?
    发表于 04-01 11:26 661次阅读
    为何国外<b class='flag-5'>工程师</b>偏爱使用for(;;)来实现MCU死循环?

    单片机如何通过代码控制硬件:一名工程师的分享

    今天跟大家聊聊单片机是怎样通过代码来操控硬件的。作为一名单片机工程师,我们平时的工作就像是给单片机编写“指令集”,让它按照我们的意图去驱动各种硬件设备。
    的头像 发表于 03-06 14:46 1518次阅读
    单片机如何通过<b class='flag-5'>代码</b>控制硬件:一名<b class='flag-5'>工程师</b>的分享