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

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

相关文章

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

poj 1258 Agri-Net(最小生成树模板代码)

感觉用这题来当模板更适合。 题意就是给你邻接矩阵求最小生成树啦。~ prim代码:效率很高。172k...0ms。 #include<stdio.h>#include<algorithm>using namespace std;const int MaxN = 101;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int n

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者:计算机编程-吉哥 🍊简介:专业从事JavaWeb程序开发,微信小程序开发,定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事,生活就是快乐的。 🍊心愿:点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能

代码随想录冲冲冲 Day39 动态规划Part7

198. 打家劫舍 dp数组的意义是在第i位的时候偷的最大钱数是多少 如果nums的size为0 总价值当然就是0 如果nums的size为1 总价值是nums[0] 遍历顺序就是从小到大遍历 之后是递推公式 对于dp[i]的最大价值来说有两种可能 1.偷第i个 那么最大价值就是dp[i-2]+nums[i] 2.不偷第i个 那么价值就是dp[i-1] 之后取这两个的最大值就是d

pip-tools:打造可重复、可控的 Python 开发环境,解决依赖关系,让代码更稳定

在 Python 开发中,管理依赖关系是一项繁琐且容易出错的任务。手动更新依赖版本、处理冲突、确保一致性等等,都可能让开发者感到头疼。而 pip-tools 为开发者提供了一套稳定可靠的解决方案。 什么是 pip-tools? pip-tools 是一组命令行工具,旨在简化 Python 依赖关系的管理,确保项目环境的稳定性和可重复性。它主要包含两个核心工具:pip-compile 和 pip

D4代码AC集

贪心问题解决的步骤: (局部贪心能导致全局贪心)    1.确定贪心策略    2.验证贪心策略是否正确 排队接水 #include<bits/stdc++.h>using namespace std;int main(){int w,n,a[32000];cin>>w>>n;for(int i=1;i<=n;i++){cin>>a[i];}sort(a+1,a+n+1);int i=1

html css jquery选项卡 代码练习小项目

在学习 html 和 css jquery 结合使用的时候 做好是能尝试做一些简单的小功能,来提高自己的 逻辑能力,熟悉代码的编写语法 下面分享一段代码 使用html css jquery选项卡 代码练习 <div class="box"><dl class="tab"><dd class="active">手机</dd><dd>家电</dd><dd>服装</dd><dd>数码</dd><dd

生信代码入门:从零开始掌握生物信息学编程技能

少走弯路,高效分析;了解生信云,访问 【生信圆桌x生信专用云服务器】 : www.tebteb.cc 介绍 生物信息学是一个高度跨学科的领域,结合了生物学、计算机科学和统计学。随着高通量测序技术的发展,海量的生物数据需要通过编程来进行处理和分析。因此,掌握生信编程技能,成为每一个生物信息学研究者的必备能力。 生信代码入门,旨在帮助初学者从零开始学习生物信息学中的编程基础。通过学习常用

husky 工具配置代码检查工作流:提交代码至仓库前做代码检查

提示:这篇博客以我前两篇博客作为先修知识,请大家先去看看我前两篇博客 博客指路:前端 ESlint 代码规范及修复代码规范错误-CSDN博客前端 Vue3 项目开发—— ESLint & prettier 配置代码风格-CSDN博客 husky 工具配置代码检查工作流的作用 在工作中,我们经常需要将写好的代码提交至代码仓库 但是由于程序员疏忽而将不规范的代码提交至仓库,显然是不合理的 所

Unity3D自带Mouse Look鼠标视角代码解析。

Unity3D自带Mouse Look鼠标视角代码解析。 代码块 代码块语法遵循标准markdown代码,例如: using UnityEngine;using System.Collections;/// MouseLook rotates the transform based on the mouse delta./// Minimum and Maximum values can