10条写高质量代码建议

小微 科技10条写高质量代码建议已关闭评论105字数 1532阅读模式
摘要写高质量的代码,不管你是程序员,架构师,这是最基本的技能。但是什么是高质量代码呢?有人说是clean code(整洁代码),有人要有好的流程,有人说要有好的工具等等。我想说一下我自...

写高质量的代码,无论你是程序员,架构师,这是最基本的技巧。然而什么是高质量代码呢?有人说是clean code(整洁代码),有人要有好的流程,有人说要有好的工具等等。我想说一下我自己的想法和我通过自己经验总结的10条建议。在列出这些建议以前,我想说一下为何要写高质量代码。

为何要写高质量代码?文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

  • 大部份的工作都是保护工作,这是一个不争的事实。无论你在大厂的,还是小厂,大部份的时候咱们都是在保护一个项目,然后在上面做些修改,改bugs等等。如果是高质量并且可读性强的代码,会给咱们保护带来很大的利便。
  • 咱们花80%的时间都是在读代码而只有剩下20%时间写代码,这也是典型的二八原理,写出来的代码都是给人读,而不但是给机器读。
  • 质量不高的代码(quick and dirty)的保护本钱跟着时间的推移保护本钱愈来愈高,愈来愈难保护,每一次新加功能,都异样艰巨,不能及时推出新功能,终究乃至致使公司倒闭。
  • 文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

    4.如果代码质量不高,浏览难题,也会致使程序员不愿意修改已有的代码,而是自己写的代码接替。这样致使代码臃肿,重复。文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

    5.代码质量不高,直接影响产品的质量问题,客户的满意度降落。文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

    那如何提高咱们的代码质量?文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

    1.使用成心义的名字,这个在bob大叔在整洁代码里也无比强调这点,比如一个变量daysSinceCreation.一眼就能开出来这个是干什么的。如果是一个办法,直接看办法名,我就知道这个是干什么,比如setWindowTitle。下面有几个例子,右侧是举荐的命名。文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

    • validateForm --->getErrors,isValid,bindFromRequest
    • getToken-->createToken,generateToken,fetchToken
    • processLogin-->runPostRegistrationActions

    2.减少注释,尽可能让代码自己展现自己的用意。然而不是说注释不重要,不少时候,注释很重要,特别是一些特殊逻辑。然而咱们也知道保护注释,是一种很难题事情,时常产生的是,代码修改提交完成,然而注释没有改,致使不少的误会。文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

    3.重构,越早重构越好。当咱们发现质量很差的代码(比如 sonarlint检测到不合规的代码),咱们要抽时间把他们修改了,而不是任其发展。大家可能知道那个“破窗理论”,如果无论不问,只会愈来愈糟糕。文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

    4.单一职责,一个函数只做一件事,参数尽可能少,2个最佳,不能太多。这也是SOLID原则之一。文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

    5.一定要写测试。多年前,大家很注重TDD,然而TDD也有本身的问题。实际上,很少有公司利用严格的TDD进程。 与其说是测试优先开发,更具体地说,是任何新代码都必需有新测试代码。 换句话说,您永久不会在没有测试代码的情况下发生一个新代码。文章源自微观生活(93wg.com)微观生活-https://93wg.com/2371.html

    6.接口优先,任什么时候候都从接口开始,然后才开始具体的实现。接口也是实现组件的可插入性(Pluggability)的关键。

    7.迭代开发,这也是麻利开发的核心。

    8.独立组件架构,独立组件架构必需设计成其他组件的依赖性最小,这样,每一一个组件通过很小的改动,就能够不少别之处使用。

    9.优秀的工具(包含IDE以及插件),比如说咱们在开发Java时候,现在大部份都会用Intellij IDEA IDE 以及插件sonarlint和IDEA code style。

    10.不要从新发明轮子,要用现成优秀的类库,然而不要使用提供几近相同功能的多个库。

    有高质量可读的代码是把产品做好的条件。 难以理解的代码不但会吓坏您的同事(和您未来的自己),而且还会掩盖过错并损坏整个团队的开发进度,由于每一次修改都需要两倍乃至更多的时间。

    以上就是微观生活(93wg.com)关于“10条写高质量代码建议”的详细内容,希望对大家有所帮助!

    继续阅读
     
    小微
    • 版权声明: 本文部分文字与图片资源来自于网络,转载此文是出于传递更多信息之目的,若有来源标注错误或侵犯了您的合法权益,请立即通知我们(管理员邮箱:81118366@qq.com),情况属实,我们会第一时间予以删除,并同时向您表示歉意,谢谢!
    • 转载请务必保留本文链接:https://93wg.com/2371.html