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

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

相关文章

C++使用栈实现括号匹配的代码详解

《C++使用栈实现括号匹配的代码详解》在编程中,括号匹配是一个常见问题,尤其是在处理数学表达式、编译器解析等任务时,栈是一种非常适合处理此类问题的数据结构,能够精确地管理括号的匹配问题,本文将通过C+... 目录引言问题描述代码讲解代码解析栈的状态表示测试总结引言在编程中,括号匹配是一个常见问题,尤其是在

Java调用DeepSeek API的最佳实践及详细代码示例

《Java调用DeepSeekAPI的最佳实践及详细代码示例》:本文主要介绍如何使用Java调用DeepSeekAPI,包括获取API密钥、添加HTTP客户端依赖、创建HTTP请求、处理响应、... 目录1. 获取API密钥2. 添加HTTP客户端依赖3. 创建HTTP请求4. 处理响应5. 错误处理6.

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置(可选)启动服务应用场景

Python中顺序结构和循环结构示例代码

《Python中顺序结构和循环结构示例代码》:本文主要介绍Python中的条件语句和循环语句,条件语句用于根据条件执行不同的代码块,循环语句用于重复执行一段代码,文章还详细说明了range函数的使... 目录一、条件语句(1)条件语句的定义(2)条件语句的语法(a)单分支 if(b)双分支 if-else(

MySQL数据库函数之JSON_EXTRACT示例代码

《MySQL数据库函数之JSON_EXTRACT示例代码》:本文主要介绍MySQL数据库函数之JSON_EXTRACT的相关资料,JSON_EXTRACT()函数用于从JSON文档中提取值,支持对... 目录前言基本语法路径表达式示例示例 1: 提取简单值示例 2: 提取嵌套值示例 3: 提取数组中的值注意

CSS3中使用flex和grid实现等高元素布局的示例代码

《CSS3中使用flex和grid实现等高元素布局的示例代码》:本文主要介绍了使用CSS3中的Flexbox和Grid布局实现等高元素布局的方法,通过简单的两列实现、每行放置3列以及全部代码的展示,展示了这两种布局方式的实现细节和效果,详细内容请阅读本文,希望能对你有所帮助... 过往的实现方法是使用浮动加

JAVA调用Deepseek的api完成基本对话简单代码示例

《JAVA调用Deepseek的api完成基本对话简单代码示例》:本文主要介绍JAVA调用Deepseek的api完成基本对话的相关资料,文中详细讲解了如何获取DeepSeekAPI密钥、添加H... 获取API密钥首先,从DeepSeek平台获取API密钥,用于身份验证。添加HTTP客户端依赖使用Jav

Java实现状态模式的示例代码

《Java实现状态模式的示例代码》状态模式是一种行为型设计模式,允许对象根据其内部状态改变行为,本文主要介绍了Java实现状态模式的示例代码,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来... 目录一、简介1、定义2、状态模式的结构二、Java实现案例1、电灯开关状态案例2、番茄工作法状态案例

nginx-rtmp-module模块实现视频点播的示例代码

《nginx-rtmp-module模块实现视频点播的示例代码》本文主要介绍了nginx-rtmp-module模块实现视频点播,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习... 目录预置条件Nginx点播基本配置点播远程文件指定多个播放位置参考预置条件配置点播服务器 192.

CSS自定义浏览器滚动条样式完整代码

《CSS自定义浏览器滚动条样式完整代码》:本文主要介绍了如何使用CSS自定义浏览器滚动条的样式,包括隐藏滚动条的角落、设置滚动条的基本样式、轨道样式和滑块样式,并提供了完整的CSS代码示例,通过这些技巧,你可以为你的网站添加个性化的滚动条样式,从而提升用户体验,详细内容请阅读本文,希望能对你有所帮助...