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

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

相关文章

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供... 目录1. SSE 简介1.1 什么是 SSE?1.2 SSE 的优点1.3 适用场景2. Spring WebFlu

java之Objects.nonNull用法代码解读

《java之Objects.nonNull用法代码解读》:本文主要介绍java之Objects.nonNull用法代码,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Java之Objects.nonwww.chinasem.cnNull用法代码Objects.nonN

SpringBoot实现MD5加盐算法的示例代码

《SpringBoot实现MD5加盐算法的示例代码》加盐算法是一种用于增强密码安全性的技术,本文主要介绍了SpringBoot实现MD5加盐算法的示例代码,文中通过示例代码介绍的非常详细,对大家的学习... 目录一、什么是加盐算法二、如何实现加盐算法2.1 加盐算法代码实现2.2 注册页面中进行密码加盐2.

python+opencv处理颜色之将目标颜色转换实例代码

《python+opencv处理颜色之将目标颜色转换实例代码》OpenCV是一个的跨平台计算机视觉库,可以运行在Linux、Windows和MacOS操作系统上,:本文主要介绍python+ope... 目录下面是代码+ 效果 + 解释转HSV: 关于颜色总是要转HSV的掩膜再标注总结 目标:将红色的部分滤

在C#中调用Python代码的两种实现方式

《在C#中调用Python代码的两种实现方式》:本文主要介绍在C#中调用Python代码的两种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C#调用python代码的方式1. 使用 Python.NET2. 使用外部进程调用 Python 脚本总结C#调

Java时间轮调度算法的代码实现

《Java时间轮调度算法的代码实现》时间轮是一种高效的定时调度算法,主要用于管理延时任务或周期性任务,它通过一个环形数组(时间轮)和指针来实现,将大量定时任务分摊到固定的时间槽中,极大地降低了时间复杂... 目录1、简述2、时间轮的原理3. 时间轮的实现步骤3.1 定义时间槽3.2 定义时间轮3.3 使用时