职场人生(十一):代码不仅是用来运行的,更是用来看的

2024-03-20 04:58

本文主要是介绍职场人生(十一):代码不仅是用来运行的,更是用来看的,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

public static string StringTruncat(string oldStr, int maxLength, string endWith){if (string.IsNullOrEmpty(oldStr))return oldStr + endWith;if (maxLength < 1)throw new Exception("返回的字符串长度必须大于[0] ");if (oldStr.Length > maxLength){string strTmp = oldStr.Substring(0, maxLength);if (string.IsNullOrEmpty(endWith))return strTmp;elsereturn strTmp + endWith;}return oldStr;}   
   
 ///   <summary>   ///   将指定字符串按指定长度进行剪切,   ///   </summary>   ///   <param   name= "oldStr "> 需要截断的字符串 </param>   ///   <param   name= "maxLength "> 字符串的最大长度 </param>   ///   <param   name= "endWith "> 超过长度的后缀 </param>   ///   <returns> 如果超过长度,返回截断后的新字符串加上后缀,否则,返回原字符串 </returns>   public static string StringTruncat(string oldStr, int maxLength, string endWith){// 原字符串不能为空if (string.IsNullOrEmpty(oldStr))return oldStr + endWith;// 返回的字符串长度必须大于0if (maxLength < 1)throw new Exception("返回的字符串长度必须大于[0] ");// 处理截取if (oldStr.Length > maxLength){// 截取string strTmp = oldStr.Substring(0, maxLength);// 加后缀if (string.IsNullOrEmpty(endWith))return strTmp;elsereturn strTmp + endWith;}return oldStr;}   

通过两段相同代码容易得出:代码需要注释,这是必须的,不可推卸的责任。有了注释,才能让自己或者接手项目的人,快速的了解代码的功能,毕竟代码是指示机器的,而注释才是人和人间的沟通的标准。

 

即使是自己写的项目,过一个月,让你光看代码也费劲儿,因为代码需要一行一行的读完了,才有条件推断它的功能、逻辑。

 

程序员的跳槽太常见了,难免项目会让别人接手做维护,要是你的代码没有注释,用他的思维捋顺你的支离破碎的想法,他会把你的八辈祖宗都骂了。这不仅会耽误项目进度,浪费不必要的时间,也是道德的缺失。换位思考,你会怎样?

 

不为别人考虑,或者懒得为别人着想,心太窄,只会让自己的路越走越窄,最终无路可走,你只有辞职的份了。

 

站在人的角度,代码不是用来运行的,而是用来看的,用来更好的、高效的沟通,只有这样,你、我、企业、社会才能共同进步。



这篇关于职场人生(十一):代码不仅是用来运行的,更是用来看的的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

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