如何写出漂亮的代码-代码整洁之道

2024-04-02 23:58

本文主要是介绍如何写出漂亮的代码-代码整洁之道,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

参考:https://www.phpmianshi.com/?id=196

背景

代码本就该是直接简单的,横就是横,纵就是纵,架构原本也本是清晰明了的,模块是模块,过程是过程。

可随着项目生命周期的变长,随着需求不断的被实现,面对不同思想的人,不同场景的要求,不同技能水平的实施,就让原本平直的路走成了立交桥,织成了逻辑网。这时候再浏览代码,要走通某一个流程,即便是熟悉路况的“本地人”,编写代码的“原住民”也不一定能走的顺畅。

 

Robert Martin的这句话非常合适:

“唯一能有效测量代码质量的方式是每分钟说多少个What-the-Fk ”

让我深入解释一下:

做代码回顾的时候,我的脑海会涌现出三种不同的情绪:

· What-the-Fk (厌恶)—这代码并不需要.**

· What-the-Fk (欣赏)— 小伙子很机智**

· What-the-Fk (无奈)—不知道在说什么**

所以当我们看代码的时候,是什么最先影响我们呢?是代码的整洁漂亮。同时书写整洁漂亮的代码是一名伟大的软件匠人的标志。

命名

 

Kendrick Lamar很好的解释道:

”如果我要讲一个真实的故事,我会从我的命名开始“

我们命名函数、类、参数、包以及其他。

你的命名应该望文知义。选择好的名称会花时间,但是当其更艰难复杂的时候却可以节省更多时间。所以注意你的命名,如若有合适的名字就替换掉。每个阅读你代码的人都会因此而很感谢你。

牢记变量、函数或者类的名称应该要回答这三个大问题:存在的理由?做了什么?和如何使用?

函数只做一件事

 

这里有两条书写整洁函数的黄金定律:

· 代码应该少

· 函数应该专注做一件事,并且做精

所以这也意味着你的函数不应该太大来嵌套其他结构。同时,函数的缩进,不应该大于一个或者两个。该技巧可以使得代码更容易阅读理解消化。除此之外,我们也要使得函数内的语句处于同一个抽象程度。

注释并不能弥补劣质的代码

Venus Williams曾很好地说道:

“每个人有自己的注释,这就是谣言开始的方式”

注释就像两面刀。没有什么比得上放置妥当的注解。另一方面,没有比无聊无用的注解更浪费空间的。同时没有比传递错误信息的注解更具有破坏力的。

简而言之,注释至多是个必要的恶魔。为什么这么说?虽然不是一直但是大部分时候,注释越老,维护起来越困难,大部分程序员都因为不维护注释而臭名昭著。

代码移动和更改:代码块移动到其他地方,而注释不随着移动,就会成为一个问题!

要牢记,带有一点注释并且整洁和有表现力的代码,要远远好过复杂并带有大量注释的代码。不要浪费时间去解释你写的代码,而去投入时间去使其整洁。

重构清晰代码的技能习惯

没有人一开始就能写出优美散文一样的代码,整洁的代码是用心重构出来的。

不清晰的代码总是会触犯标准,对临床医学来讲病人生什么病,开什么处方,吃什么药是有章可循的。坏代码违反整洁标准的哪一条,就使用哪一条的处方来修改。这个修改的处方和药是可以积累和总结的,而且有已经总结好的经验。剩下的是学习和养成习惯。

对已有代码的整洁化不是大范围的重写,是在保证不影响已有功能的前提下坚持做的改进优化。

唯有源头活水来,甲严格执行整洁之道的准则,乙坚持己见,丙随意而为,即使甲有熟练的整洁技能和习惯也改不完项目的所有问题。

对编程来讲,一个人的习惯是能力,一个团队的能力才是习惯。

CleanCode之道

 

这篇关于如何写出漂亮的代码-代码整洁之道的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/871402

相关文章

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Visual Studio 2022 编译C++20代码的图文步骤

《VisualStudio2022编译C++20代码的图文步骤》在VisualStudio中启用C++20import功能,需设置语言标准为ISOC++20,开启扫描源查找模块依赖及实验性标... 默认创建Visual Studio桌面控制台项目代码包含C++20的import方法。右键项目的属性:

MySQL数据库的内嵌函数和联合查询实例代码

《MySQL数据库的内嵌函数和联合查询实例代码》联合查询是一种将多个查询结果组合在一起的方法,通常使用UNION、UNIONALL、INTERSECT和EXCEPT关键字,下面:本文主要介绍MyS... 目录一.数据库的内嵌函数1.1聚合函数COUNT([DISTINCT] expr)SUM([DISTIN

Java实现自定义table宽高的示例代码

《Java实现自定义table宽高的示例代码》在桌面应用、管理系统乃至报表工具中,表格(JTable)作为最常用的数据展示组件,不仅承载对数据的增删改查,还需要配合布局与视觉需求,而JavaSwing... 目录一、项目背景详细介绍二、项目需求详细介绍三、相关技术详细介绍四、实现思路详细介绍五、完整实现代码

Go语言代码格式化的技巧分享

《Go语言代码格式化的技巧分享》在Go语言的开发过程中,代码格式化是一个看似细微却至关重要的环节,良好的代码格式化不仅能提升代码的可读性,还能促进团队协作,减少因代码风格差异引发的问题,Go在代码格式... 目录一、Go 语言代码格式化的重要性二、Go 语言代码格式化工具:gofmt 与 go fmt(一)

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.

基于 HTML5 Canvas 实现图片旋转与下载功能(完整代码展示)

《基于HTML5Canvas实现图片旋转与下载功能(完整代码展示)》本文将深入剖析一段基于HTML5Canvas的代码,该代码实现了图片的旋转(90度和180度)以及旋转后图片的下载... 目录一、引言二、html 结构分析三、css 样式分析四、JavaScript 功能实现一、引言在 Web 开发中,

Python如何去除图片干扰代码示例

《Python如何去除图片干扰代码示例》图片降噪是一个广泛应用于图像处理的技术,可以提高图像质量和相关应用的效果,:本文主要介绍Python如何去除图片干扰的相关资料,文中通过代码介绍的非常详细,... 目录一、噪声去除1. 高斯噪声(像素值正态分布扰动)2. 椒盐噪声(随机黑白像素点)3. 复杂噪声(如伪

Java Spring ApplicationEvent 代码示例解析

《JavaSpringApplicationEvent代码示例解析》本文解析了Spring事件机制,涵盖核心概念(发布-订阅/观察者模式)、代码实现(事件定义、发布、监听)及高级应用(异步处理、... 目录一、Spring 事件机制核心概念1. 事件驱动架构模型2. 核心组件二、代码示例解析1. 事件定义

Python实例题之pygame开发打飞机游戏实例代码

《Python实例题之pygame开发打飞机游戏实例代码》对于python的学习者,能够写出一个飞机大战的程序代码,是不是感觉到非常的开心,:本文主要介绍Python实例题之pygame开发打飞机... 目录题目pygame-aircraft-game使用 Pygame 开发的打飞机游戏脚本代码解释初始化部