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

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

相关文章

HTML5的input标签的`type`属性值详解和代码示例

《HTML5的input标签的`type`属性值详解和代码示例》HTML5的`input`标签提供了多种`type`属性值,用于创建不同类型的输入控件,满足用户输入的多样化需求,从文本输入、密码输入、... 目录一、引言二、文本类输入类型2.1 text2.2 password2.3 textarea(严格

JAVA项目swing转javafx语法规则以及示例代码

《JAVA项目swing转javafx语法规则以及示例代码》:本文主要介绍JAVA项目swing转javafx语法规则以及示例代码的相关资料,文中详细讲解了主类继承、窗口创建、布局管理、控件替换、... 目录最常用的“一行换一行”速查表(直接全局替换)实际转换示例(JFramejs → JavaFX)迁移建

Go异常处理、泛型和文件操作实例代码

《Go异常处理、泛型和文件操作实例代码》Go语言的异常处理机制与传统的面向对象语言(如Java、C#)所使用的try-catch结构有所不同,它采用了自己独特的设计理念和方法,:本文主要介绍Go异... 目录一:异常处理常见的异常处理向上抛中断程序恢复程序二:泛型泛型函数泛型结构体泛型切片泛型 map三:文

MyBatis中的两种参数传递类型详解(示例代码)

《MyBatis中的两种参数传递类型详解(示例代码)》文章介绍了MyBatis中传递多个参数的两种方式,使用Map和使用@Param注解或封装POJO,Map方式适用于动态、不固定的参数,但可读性和安... 目录✅ android方式一:使用Map<String, Object>✅ 方式二:使用@Param

SpringBoot实现图形验证码的示例代码

《SpringBoot实现图形验证码的示例代码》验证码的实现方式有很多,可以由前端实现,也可以由后端进行实现,也有很多的插件和工具包可以使用,在这里,我们使用Hutool提供的小工具实现,本文介绍Sp... 目录项目创建前端代码实现约定前后端交互接口需求分析接口定义Hutool工具实现服务器端代码引入依赖获

利用Python在万圣节实现比心弹窗告白代码

《利用Python在万圣节实现比心弹窗告白代码》:本文主要介绍关于利用Python在万圣节实现比心弹窗告白代码的相关资料,每个弹窗会显示一条温馨提示,程序通过参数方程绘制爱心形状,并使用多线程技术... 目录前言效果预览要点1. 爱心曲线方程2. 显示温馨弹窗函数(详细拆解)2.1 函数定义和延迟机制2.2

Springmvc常用的注解代码示例

《Springmvc常用的注解代码示例》本文介绍了SpringMVC中常用的控制器和请求映射注解,包括@Controller、@RequestMapping等,以及请求参数绑定注解,如@Request... 目录一、控制器与请求映射注解二、请求参数绑定注解三、其他常用注解(扩展)四、注解使用注意事项一、控制

C++简单日志系统实现代码示例

《C++简单日志系统实现代码示例》日志系统是成熟软件中的一个重要组成部分,其记录软件的使用和运行行为,方便事后进行故障分析、数据统计等,:本文主要介绍C++简单日志系统实现的相关资料,文中通过代码... 目录前言Util.hppLevel.hppLogMsg.hppFormat.hppSink.hppBuf

VS Code中的Python代码格式化插件示例讲解

《VSCode中的Python代码格式化插件示例讲解》在Java开发过程中,代码的规范性和可读性至关重要,一个团队中如果每个开发者的代码风格各异,会给代码的维护、审查和协作带来极大的困难,这篇文章主... 目录前言如何安装与配置使用建议与技巧如何选择总结前言在 VS Code 中,有几款非常出色的 pyt

利用Python将PDF文件转换为PNG图片的代码示例

《利用Python将PDF文件转换为PNG图片的代码示例》在日常工作和开发中,我们经常需要处理各种文档格式,PDF作为一种通用且跨平台的文档格式,被广泛应用于合同、报告、电子书等场景,然而,有时我们需... 目录引言为什么选择 python 进行 PDF 转 PNG?Spire.PDF for Python