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

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+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot?二、环境准备与部署2.1 安装 RustF

Python实现Excel批量样式修改器(附完整代码)

《Python实现Excel批量样式修改器(附完整代码)》这篇文章主要为大家详细介绍了如何使用Python实现一个Excel批量样式修改器,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一... 目录前言功能特性核心功能界面特性系统要求安装说明使用指南基本操作流程高级功能技术实现核心技术栈关键函

Redis实现高效内存管理的示例代码

《Redis实现高效内存管理的示例代码》Redis内存管理是其核心功能之一,为了高效地利用内存,Redis采用了多种技术和策略,如优化的数据结构、内存分配策略、内存回收、数据压缩等,下面就来详细的介绍... 目录1. 内存分配策略jemalloc 的使用2. 数据压缩和编码ziplist示例代码3. 优化的

Python 基于http.server模块实现简单http服务的代码举例

《Python基于http.server模块实现简单http服务的代码举例》Pythonhttp.server模块通过继承BaseHTTPRequestHandler处理HTTP请求,使用Threa... 目录测试环境代码实现相关介绍模块简介类及相关函数简介参考链接测试环境win11专业版python

Python从Word文档中提取图片并生成PPT的操作代码

《Python从Word文档中提取图片并生成PPT的操作代码》在日常办公场景中,我们经常需要从Word文档中提取图片,并将这些图片整理到PowerPoint幻灯片中,手动完成这一任务既耗时又容易出错,... 目录引言背景与需求解决方案概述代码解析代码核心逻辑说明总结引言在日常办公场景中,我们经常需要从 W

使用Spring Cache本地缓存示例代码

《使用SpringCache本地缓存示例代码》缓存是提高应用程序性能的重要手段,通过将频繁访问的数据存储在内存中,可以减少数据库访问次数,从而加速数据读取,:本文主要介绍使用SpringCac... 目录一、Spring Cache简介核心特点:二、基础配置1. 添加依赖2. 启用缓存3. 缓存配置方案方案

MySQL的配置文件详解及实例代码

《MySQL的配置文件详解及实例代码》MySQL的配置文件是服务器运行的重要组成部分,用于设置服务器操作的各种参数,下面:本文主要介绍MySQL配置文件的相关资料,文中通过代码介绍的非常详细,需要... 目录前言一、配置文件结构1.[mysqld]2.[client]3.[mysql]4.[mysqldum

Python多线程实现大文件快速下载的代码实现

《Python多线程实现大文件快速下载的代码实现》在互联网时代,文件下载是日常操作之一,尤其是大文件,然而,网络条件不稳定或带宽有限时,下载速度会变得很慢,本文将介绍如何使用Python实现多线程下载... 目录引言一、多线程下载原理二、python实现多线程下载代码说明:三、实战案例四、注意事项五、总结引

IDEA与MyEclipse代码量统计方式

《IDEA与MyEclipse代码量统计方式》文章介绍在项目中不安装第三方工具统计代码行数的方法,分别说明MyEclipse通过正则搜索(排除空行和注释)及IDEA使用Statistic插件或调整搜索... 目录项目场景MyEclipse代码量统计IDEA代码量统计总结项目场景在项目中,有时候我们需要统计

MySQL设置密码复杂度策略的完整步骤(附代码示例)

《MySQL设置密码复杂度策略的完整步骤(附代码示例)》MySQL密码策略还可能包括密码复杂度的检查,如是否要求密码包含大写字母、小写字母、数字和特殊字符等,:本文主要介绍MySQL设置密码复杂度... 目录前言1. 使用 validate_password 插件1.1 启用 validate_passwo