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

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

相关文章

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(一)

k8s上运行的mysql、mariadb数据库的备份记录(支持x86和arm两种架构)

《k8s上运行的mysql、mariadb数据库的备份记录(支持x86和arm两种架构)》本文记录在K8s上运行的MySQL/MariaDB备份方案,通过工具容器执行mysqldump,结合定时任务实... 目录前言一、获取需要备份的数据库的信息二、备份步骤1.准备工作(X86)1.准备工作(arm)2.手

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. 事件定义