代码写的好坏,合作伙伴的评价是最重要的!

2023-11-22 15:18

本文主要是介绍代码写的好坏,合作伙伴的评价是最重要的!,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在这里插入图片描述
程序媛:

(偷图)祝:女神节快乐!


今天,我们来讨论一下优秀的代码是如何产生的?

一个优秀的系统,需要由优秀的项目经理、优秀的架构师和优秀的程序员共同的努力。作为一名最低端的程序员,不聊设计,不聊架构,我们就聊一聊代码。

代码的五层境界

1. 可用的代码(实现)

代码的目的很简单,就是为了实现功能

只要实现了想要的功能,满足了项目的需求,就代表着已经入行了。

但是,仅仅是实现了功能,配合上简单的注释,堪称最基础的代码。

2. 合格的代码(可读)

合格的代码,是建立在可用的基础上,在保证代码可用的前提下,对其进行规范检验。主要包括:命名规范、逻辑规范、使用规范。

  • 命名规范:不同的语言有不同的命名规范。例如 java 的包名全为小写字母、变量名为驼峰命名、常量命名为大写英文字母等等。具体可以参考相关手册(如 阿里的 Java 开发手册、微软的 C#.NET 开发规范等)
  • 逻辑规范。逻辑在代码中主要体现在三个部分: if、while、for。避免冗余的逻辑判断和无结束条件的循环(死循环)以及操作中异常情况的处理等,都需要考虑。
  • 使用规范。举个例子,在某些情况下,当调用某几个方法都可以实现该功能时,最终应该选择哪个?如 JS 中最常见的: map、find、filter、findIndex、some、forEach 等等,这几个方法在大多数情况下是可以互换的,哪一个才是最符合需求的,这也是需要仔细斟酌。

能够写出满足规范的可用代码,我们可以称之为合格。也就是说,这时候,你已经是一名合格的程序员了,已经可以参与项目的开发了。

3. 良好的代码(清晰、优雅)

前两层,都着重体现在一个代码块中,都是部分代码。而想要达到良好的层次。就需要朝着整体的方向考虑。

良好的代码风格,其最核心的评判标准就是: 层次感。

第二层的代码其实就是可读的标准。理论上来说,这种代码,作为维护人员理应可以看懂了,但是,在一个项目中,代码上万行,甚至十万、百万行。如果都仅仅满足代码规范,那就太累了。

所以,代码的层次就非常重要。

重构,就是这一层次的一个重要步骤。

这一层的代码,是极具层次感、模块化的,配合上清晰的注释模板与说明文档,最终要达到让一个外行也能看懂你这部分代码大概是在做什么?

4. 优秀的代码(高效)

代码,最重要的是什么?

高效!!!

为什么说它重要却又避而不谈?

很简单,因为 90% 的程序员达不到谈代码效率的层次(包括我)。

计算机与人脑相比最大的优势就在于效率极高。

而普通合格的代码,其产生的效率也远远的大于人工,所以,很多中小型数据量的场景下,企业不会给你提供大量的时间去提升10%左右并不明显的效率。

而效率,在大数据量的场景下,就显得尤为重要。

这也是为什么大厂的面试,都有算法面试的原因。优秀的算法,就是提升代码效率基础。

然而,即使在大厂,能上升到研究代码效率的层次的程序员,也是凤毛麟角。

到达这一层次的程序员,写出来的代码最大的特点就是简洁高效,而同时,为了追求高效,不可避免的会有一些生涩难懂的底层知识。所以这时候,优秀的代码注释也显得格外重要。

5. 返璞归真,回望初衷(完美)

上升到第四层,能写出优雅且高效的代码,就是最完美的状态了吗?

最最重要的,其实并不在于你的代码有多么的优秀,而在于,你的代码为团队,为合作伙伴的贡献多少。

举一个我在工作中遇到真实的案例。

我是做全栈开发的。某一段时间因为部门前端开发人员流失,我的主要精力放在了前端。因为部门的开发模式是前后端分离的,所以就当时的那个系统,我是和后端开发人员合作的。后端的伙伴非常优秀,代码写的也很规范,文档也很详细。但有一次,因为前端无法使用后端返回的数据(准确来说,是框架不支持,如果非要使用,只能定制这个功能,极其影响效率),但后端起初是不愿意修改数据,因为他认为目前的这种写法是非常高效,且理论上来说前端是可以使用的。如果修改,会影响到后端的一部分效率。后来经过一番讨论,我给出的理由是,后端降低部分效率,前端效率极高且稳定;如果后端不修改,后端代码效率的确很高,但前端效率会极低且极不稳定(因为 js 的效率是基于浏览器内核,客户端电脑配置等不稳定因素的),另外众所周知前端二次处理数据本身就是不符合前后端分离规范的。

说这个例子,主要就是提醒大家,代码的初衷是为项目服务。而不是某一部分。并不是规范、优雅、高效的代码,就一定是完美的代码,有时候,也可以降低代码标准去迎合合作人的代码,为整体项目的代码风格、效率做提升

所以,还是题目中这句话。

代码的好坏,是要合作伙伴来评价的,因为,我们是一个整体

所以我们的代码要:

  • 让合作伙伴感觉到舒服、顺畅、清晰、易读;
  • 让维护人员感觉到整齐、优雅、亲近;
  • 让技术人员感觉到高效、惊艳的代码;

这,才是优秀的代码!

这篇关于代码写的好坏,合作伙伴的评价是最重要的!的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

Java中Map.Entry()含义及方法使用代码

《Java中Map.Entry()含义及方法使用代码》:本文主要介绍Java中Map.Entry()含义及方法使用的相关资料,Map.Entry是Java中Map的静态内部接口,用于表示键值对,其... 目录前言 Map.Entry作用核心方法常见使用场景1. 遍历 Map 的所有键值对2. 直接修改 Ma

深入解析 Java Future 类及代码示例

《深入解析JavaFuture类及代码示例》JavaFuture是java.util.concurrent包中用于表示异步计算结果的核心接口,下面给大家介绍JavaFuture类及实例代码,感兴... 目录一、Future 类概述二、核心工作机制代码示例执行流程2. 状态机模型3. 核心方法解析行为总结:三

python获取cmd环境变量值的实现代码

《python获取cmd环境变量值的实现代码》:本文主要介绍在Python中获取命令行(cmd)环境变量的值,可以使用标准库中的os模块,需要的朋友可以参考下... 前言全局说明在执行py过程中,总要使用到系统环境变量一、说明1.1 环境:Windows 11 家庭版 24H2 26100.4061

pandas实现数据concat拼接的示例代码

《pandas实现数据concat拼接的示例代码》pandas.concat用于合并DataFrame或Series,本文主要介绍了pandas实现数据concat拼接的示例代码,具有一定的参考价值,... 目录语法示例:使用pandas.concat合并数据默认的concat:参数axis=0,join=

C#代码实现解析WTGPS和BD数据

《C#代码实现解析WTGPS和BD数据》在现代的导航与定位应用中,准确解析GPS和北斗(BD)等卫星定位数据至关重要,本文将使用C#语言实现解析WTGPS和BD数据,需要的可以了解下... 目录一、代码结构概览1. 核心解析方法2. 位置信息解析3. 经纬度转换方法4. 日期和时间戳解析5. 辅助方法二、L

Python使用Code2flow将代码转化为流程图的操作教程

《Python使用Code2flow将代码转化为流程图的操作教程》Code2flow是一款开源工具,能够将代码自动转换为流程图,该工具对于代码审查、调试和理解大型代码库非常有用,在这篇博客中,我们将深... 目录引言1nVflRA、为什么选择 Code2flow?2、安装 Code2flow3、基本功能演示

IIS 7.0 及更高版本中的 FTP 状态代码

《IIS7.0及更高版本中的FTP状态代码》本文介绍IIS7.0中的FTP状态代码,方便大家在使用iis中发现ftp的问题... 简介尝试使用 FTP 访问运行 Internet Information Services (IIS) 7.0 或更高版本的服务器上的内容时,IIS 将返回指示响应状态的数字代

MySQL 添加索引5种方式示例详解(实用sql代码)

《MySQL添加索引5种方式示例详解(实用sql代码)》在MySQL数据库中添加索引可以帮助提高查询性能,尤其是在数据量大的表中,下面给大家分享MySQL添加索引5种方式示例详解(实用sql代码),... 在mysql数据库中添加索引可以帮助提高查询性能,尤其是在数据量大的表中。索引可以在创建表时定义,也可

使用C#删除Excel表格中的重复行数据的代码详解

《使用C#删除Excel表格中的重复行数据的代码详解》重复行是指在Excel表格中完全相同的多行数据,删除这些重复行至关重要,因为它们不仅会干扰数据分析,还可能导致错误的决策和结论,所以本文给大家介绍... 目录简介使用工具C# 删除Excel工作表中的重复行语法工作原理实现代码C# 删除指定Excel单元

Python实现一键PDF转Word(附完整代码及详细步骤)

《Python实现一键PDF转Word(附完整代码及详细步骤)》pdf2docx是一个基于Python的第三方库,专门用于将PDF文件转换为可编辑的Word文档,下面我们就来看看如何通过pdf2doc... 目录引言:为什么需要PDF转Word一、pdf2docx介绍1. pdf2docx 是什么2. by