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

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中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Visual Studio 2022 编译C++20代码的图文步骤

《VisualStudio2022编译C++20代码的图文步骤》在VisualStudio中启用C++20import功能,需设置语言标准为ISOC++20,开启扫描源查找模块依赖及实验性标... 默认创建Visual Studio桌面控制台项目代码包含C++20的import方法。右键项目的属性:

MySQL数据库的内嵌函数和联合查询实例代码

《MySQL数据库的内嵌函数和联合查询实例代码》联合查询是一种将多个查询结果组合在一起的方法,通常使用UNION、UNIONALL、INTERSECT和EXCEPT关键字,下面:本文主要介绍MyS... 目录一.数据库的内嵌函数1.1聚合函数COUNT([DISTINCT] expr)SUM([DISTIN

Java实现自定义table宽高的示例代码

《Java实现自定义table宽高的示例代码》在桌面应用、管理系统乃至报表工具中,表格(JTable)作为最常用的数据展示组件,不仅承载对数据的增删改查,还需要配合布局与视觉需求,而JavaSwing... 目录一、项目背景详细介绍二、项目需求详细介绍三、相关技术详细介绍四、实现思路详细介绍五、完整实现代码

Go语言代码格式化的技巧分享

《Go语言代码格式化的技巧分享》在Go语言的开发过程中,代码格式化是一个看似细微却至关重要的环节,良好的代码格式化不仅能提升代码的可读性,还能促进团队协作,减少因代码风格差异引发的问题,Go在代码格式... 目录一、Go 语言代码格式化的重要性二、Go 语言代码格式化工具:gofmt 与 go fmt(一)

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.

基于 HTML5 Canvas 实现图片旋转与下载功能(完整代码展示)

《基于HTML5Canvas实现图片旋转与下载功能(完整代码展示)》本文将深入剖析一段基于HTML5Canvas的代码,该代码实现了图片的旋转(90度和180度)以及旋转后图片的下载... 目录一、引言二、html 结构分析三、css 样式分析四、JavaScript 功能实现一、引言在 Web 开发中,

Python如何去除图片干扰代码示例

《Python如何去除图片干扰代码示例》图片降噪是一个广泛应用于图像处理的技术,可以提高图像质量和相关应用的效果,:本文主要介绍Python如何去除图片干扰的相关资料,文中通过代码介绍的非常详细,... 目录一、噪声去除1. 高斯噪声(像素值正态分布扰动)2. 椒盐噪声(随机黑白像素点)3. 复杂噪声(如伪

Java Spring ApplicationEvent 代码示例解析

《JavaSpringApplicationEvent代码示例解析》本文解析了Spring事件机制,涵盖核心概念(发布-订阅/观察者模式)、代码实现(事件定义、发布、监听)及高级应用(异步处理、... 目录一、Spring 事件机制核心概念1. 事件驱动架构模型2. 核心组件二、代码示例解析1. 事件定义

Python实例题之pygame开发打飞机游戏实例代码

《Python实例题之pygame开发打飞机游戏实例代码》对于python的学习者,能够写出一个飞机大战的程序代码,是不是感觉到非常的开心,:本文主要介绍Python实例题之pygame开发打飞机... 目录题目pygame-aircraft-game使用 Pygame 开发的打飞机游戏脚本代码解释初始化部