如何写出高质量代码——站在巨人的肩膀上

news/2024/10/18 2:37:15/

如何写出高质量代码——站在巨人的肩膀上

    • 高质量代码的三要素:可读性,可维护性,可变更性
      • 可读性强
      • 可维护性:适应软件在部署和使用中的各种情况
      • 1.3 可变更性:因需求变化而对代码进行修改

牛顿曾经说过:如果说我看得比别人更远,那是因为我站在巨人的肩膀上。这句话虽然是调侃别人的话,但是牛顿的成就也的确来源于对之前科学巨人的继承,这个巨人就是伽利略。如何写出高质量代码,异曲同工,需要多多学习先贤的优质代码,多运用内置函数/模块等,多读多写多学习。

高质量代码的三要素:可读性,可维护性,可变更性

可读性强

  • 不要编写大段代码
  • 将段落封装成一个又一个函数
  • 在编写代码的工程中养成不断重构的习惯
  • 当一个函数的代码行数达到15-20行,开始考虑是否需要重构代码。
  • 一个类不应当有太多的函数,函数过多要考虑分为多个类,一个包也不应该有太多的类
  • 参数方法名等规范:new/add , edit/mod , del , find/query
  • 释义名称:get开头的函数仅仅用于获取类属性
  • 必要的注释很重要!!!

可维护性:适应软件在部署和使用中的各种情况

  • 代码不能写死(路径为相对路径 or 通过属性文件修改 )
  • 预测可能发生的变化
  • 将某些条件设置为可配置的,需要必要的注释

1.3 可变更性:因需求变化而对代码进行修改

  • 提高代码的可复用性
  • 利用设计模式提高可变更性:经典的32个模式
  • 父类,common类,反射等;

代码质量评价:低耦合高内聚

结合高质量代码的评价标准去反推着写出高质量代码,以及多研读前辈的高质量代码,适当的运用内置模块,函数等提升代码简洁性及效率。


http://www.ppmy.cn/news/51126.html

相关文章

机器思维(个人总结)

机器思维,也称为人工智能或AI,是一种由计算机程序或机器实现的智能行为和决策的领域。这种智能可以表现为对自然语言的理解和生成、对图像和声音的理解、对环境的感知和理解、对复杂问题的推理和决策等,这些都是人类智能的核心特征。人工智能…

【JUC】Java并发机制的底层实现原理

【JUC】Java并发机制的底层实现原理 参考资料: CPU 缓存一致性 《Java并发编程的艺术》 【JUC并发编程】CAS到底加不加锁? 如何写出让 CPU 跑得更快的代码? 彻底理解Java并发编程之Synchronized关键字实现原理剖析 【JUC并发编程】Synchroni…

【观察】华为:新一代楼宇网络,使能绿建智慧化

“碳达峰”、“碳中和”目标是我国生态文明建设和高质量可持续发展的重要战略安排,将推动全社会加速向绿色低碳转型。作为全球既有建筑和每年新建建筑量最大的国家,大力发展绿色建筑对中国全方位迈向低碳社会、实现高质量发展具有重要意义。 《“十四五”…

【Linux命令行与Shell脚本编程】第五章 理解 Shell 父子关系 后台进程 协程

Linux命令行与Shell脚本编程 第五章 理解 Shell 文章目录 Linux命令行与Shell脚本编程五,理解 Shell5.1,shell的类型5.2,shell的父子关系5.2.1,进程列表 ()5.2.2 子shell的用法1,后台模式2,后台进程列表3,协程 5.3,外部命令和内建命令5.3.1,外部命令5.3.2,内建命令1,history 命…

深入理解Javascript事件处理机制

深入理解javascript事件处理机制 前言 在开发web应用程序时,事件处理机制是javascript中至关重要的一部分。许多高级特性,如事件冒泡、事件捕获和事件委托,都是通过事件处理来实现的。熟练掌握这些技术可以帮助我们更好地组织代码、提高代码…

TryHackMe-M4tr1x: Exit Denied(boot2root)

M4tr1x: Exit Denied 大多数人只看到一个完美构建的系统。但你一直都是不同的。你不仅看到表面上的东西,还看到 它下面有什么统治;调节和调节的内部关联机制 几乎完美地管理其每个模块,以至于它试图隐藏所有模块 其多面设计中的微小孔。但是&#xff0c…

高频 编码快捷键

Ctrl ​​​​​​​Ctrl W 选中文本,连续按可以扩大选中范围(以单词为单位)Ctrl Y取消Ctrl ZCtrl 链接前往链接Ctrl D在下一行复制出当前行Ctrl Backspace删除整个单词Ctrl /添加注释 或 取消注释Ctrl F在当前文件中查找文本Ctr…

设计模式取舍之道:性能权衡

目录标题 前言正文详细分析单例模式(Singleton Pattern)工厂方法模式(Factory Method Pattern)职责链模式享元模式简单工厂模式抽象工厂模式(Abstract Factory Pattern)观察者模式(Observer Pat…