今日多写一行注释,明日维护少掉一根头发

2023-10-17 00:04

本文主要是介绍今日多写一行注释,明日维护少掉一根头发,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在这里插入图片描述

👑 个人主页 👑 :😜😜😜Fish_Vast😜😜😜
🐝 个人格言 🐝 :🧐🧐🧐说到做到,言出必行🧐🧐🧐
🐸 推荐专栏 🐸 :SpringBoot
🐸 推荐专栏 🐸 :Java基础
🐸 推荐专栏 🐸 :软考
🍉 博客描述 🍉 :行好每一次程,写好每一篇文!
🍀 本篇简介 🍀 :如何看待程序员不写注释?

    🦚 个人理解:“每个人做人有自己的风格,每个人讲话有自己的艺术,而作为程序员的我们写代码自身也是别具一格。”目前本人工作从事互联网也有一段时间,编写的代码量也是逐年增长,当然代码的质量也是日渐成熟。从当时的只为了完全开发工作量过渡到愈发注重撰写代码注释、着重考虑代码后期维护性等,也算是有一定的成长和进步了。

🔫(一)注重代码质量

    🦜 本人曾经在重压之下有过半个月开发完几十个接口的经历,现在回想起来往日的经历真是不堪回首呀!当工作压力大任务重时间周期紧张的时候,我们的代码质量便会难以得到保障,这点毋庸置疑。代码质量的保障跟自己的工作经历很有关系,在午饭之余我时常跟我同事在公司外楼散步谈到程序员一般是两到三年是分水岭,而且一般跳槽更换公司时常常要写从事该专业工作三年或三年以上才会使得自己在工作经历上不吃亏,但是更多的是证明自己是能胜任该工作为前提条件。代码质量跟开发团队的核心成员有密切联系,如果开发团队的代码写得条理清楚、间隔分明、流程全面,谁不会想仿造此来创造自己的“轮子”呢?这里提及的是借鉴,不是纯粹地copy,就是一味地粘贴复制并不会提高自己的代码质量上的认知水平。

🔫(二)好的编码习惯

    🦉 习惯的养成并不是一朝一夕就能达到的,需要长期的坚持不懈地做好当下的事情才能形成。有科学依据声称28天坚持做某一件事情能让我们养成一种习惯,这个说法也是有一定的说服力的,例如我的体重偏重,我在今年二月份的时候就选择了节食+锻炼的方式,坚持了两三个月,坚持下来后便成为了我生活中的一种习惯,减肥的目的达到了,然后坚持锻炼的习惯也养成了。良好的编码习惯亦是如此,不管是什么编程语言,都有与之对应的语法规则,万变不离其宗,编码的格式大同小异。何时应该形成代码块,何时应该空格、空行等,需要我们长期的坚持形成习惯,让撰写出来的代码美观简约,让人从代码层面上阅读舒适感强。

🔫(三)常写日志和注释

    🦅 前面的两点其实算是第三点的前提条件,因为需要有扎实的编程功底,才能让后面的代码解释有美的体现!刚写代码的我很不喜欢在代码中去写日志,第一个是因为我刚开始不晓得有日志这个玩意儿,第二当我知道有日志这个玩意儿的时候我也懒得去写,抱着一个想法这代码是我自己写的什么时候看我都能看得懂,而且自己的写的代码肯定不会报错呀,自己写的代码多么地天衣无缝… …一系列的想法在我脑海中逐一飘过,导致我的前期代码中一行日志都没有。而不写注释呢?其实也不是说自己有多么地不想写,就是觉得自己的一套逻辑下来没啥毛病,加几行注释算啥事呢?这代码运行出来都不报错,写几行注释给谁看呢?

    🦅 不写日志和注释自己做一个项目还好,当自己的实践的项目多起来不仅仅是单独接手一个项目,和多个同事共同开发某些功能点时,问题就爆发了。如果刚好碰到自己的功能模块需要有别的同事调用时,或者某个同事需要复用你代码中的某一项功能代码加以改造等情况,同事很有可能会觉得你很low,为啥什么都没有写明,这要他们该咋拿需要的代码块呢?不怕别人问,就怕自己对自己的写的代码随着时间的流逝自己很有可能把这部分的内容也给忘记了,这就尴尬+不礼貌了。小伙伴们不要笑,大家肯定都有经历过自己的一段黑暗时间,就像LOL选手showmaker在世界赛场所说的一样:“失败总是贯穿自己的人生!”我们都需要经历多次的失败来完善自己的人生的精彩时刻,项目最终的交工验收不过都是每一个失败且重复不断演练过程的集合。

    🦅 没有哪一个程序员能说自己的代码写得有多么地完美无缺,哪怕是开发出我们所用的开发语言都有版本迭代、功能优化和Bug处理等情况。发明者都觉得自己做得还不够好时,那么使用者就更容易犯错了。在我们自身学习计算机相关知识的时候,其实在知识获取途径的各个地方都有着日志说明、注释或者解释文档,不仅仅是为了当前的学习,也是为了后续的巩固和维护。

🔫(四)结语

    🍂 程序员不写代码注释和日志,本人看待此的观点就是对后期维护的不负责,平白无故增加后期维护人员的工作量。很想对那些不写注释和日志的程序员说一句话就是:“今日多写一行注释,明日维护少掉一根头发”!

🍆🍆🍆路过的小伙伴,如果本篇博文对你的学习或者工作有所帮助,可以点赞+收藏+关注一波呀~👊👊👊小编后续每过一段时间会整理出CSDN写作博文,感谢您的支持哦!!!✈️✈️✈️
在这里插入图片描述

这篇关于今日多写一行注释,明日维护少掉一根头发的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

Rust中的注释使用解读

《Rust中的注释使用解读》本文介绍了Rust中的行注释、块注释和文档注释的使用方法,通过示例展示了如何在实际代码中应用这些注释,以提高代码的可读性和可维护性... 目录Rust 中的注释使用指南1. 行注释示例:行注释2. 块注释示例:块注释3. 文档注释示例:文档注释4. 综合示例总结Rust 中的注释

2024网安周今日开幕,亚信安全亮相30城

2024年国家网络安全宣传周今天在广州拉开帷幕。今年网安周继续以“网络安全为人民,网络安全靠人民”为主题。2024年国家网络安全宣传周涵盖了1场开幕式、1场高峰论坛、5个重要活动、15场分论坛/座谈会/闭门会、6个主题日活动和网络安全“六进”活动。亚信安全出席2024年国家网络安全宣传周开幕式和主论坛,并将通过线下宣讲、创意科普、成果展示等多种形式,让广大民众看得懂、记得住安全知识,同时还

vscode中文乱码问题,注释,终端,调试乱码一劳永逸版

忘记咋回事突然出现了乱码问题,很多方法都试了,注释乱码解决了,终端又乱码,调试窗口也乱码,最后经过本人不懈努力,终于全部解决了,现在分享给大家我的方法。 乱码的原因是各个地方用的编码格式不统一,所以把他们设成统一的utf8. 1.电脑的编码格式 开始-设置-时间和语言-语言和区域 管理语言设置-更改系统区域设置-勾选Bata版:使用utf8-确定-然后按指示重启 2.vscode

可测试,可维护,可移植:上位机软件分层设计的重要性

互联网中,软件工程师岗位会分前端工程师,后端工程师。这是由于互联网软件规模庞大,从业人员众多。前后端分别根据各自需求发展不一样的技术栈。那么上位机软件呢?它规模小,通常一个人就能开发一个项目。它还有必要分前后端吗? 有必要。本文从三个方面论述。分别是可测试,可维护,可移植。 可测试 软件黑盒测试更普遍,但很难覆盖所有应用场景。于是有了接口测试、模块化测试以及单元测试。都是通过降低测试对象

为备份驱动器制定备份计划:维护数据的3大方法

时间:2014-02-26 14:49 来源:网管之家 字体:[大 中 小]   您可能已经对您的电脑进行了备份,但其实这样还是远远不够的,其并非如您所认为的那样安全。您企业备份驱动器上的文件可能与您的主系统上的文件一样,容易受到灾难的影响。根据最近流行的恶意软件CryptoLocker的感染途径显示,连接到PC的外置驱动器——辅助硬盘驱动器,例如,用于备份的外部USB硬盘驱动器,可以像

在 Qt Creator 中,输入 /** 并按下Enter可以自动生成 Doxygen 风格的注释

在 Qt Creator 中,当你输入 /** 时,确实会自动补全标准的 Doxygen 风格注释。这是因为 Qt Creator 支持 Doxygen 以及类似的文档注释风格,并且提供了代码自动补全功能。 以下是如何在 Qt Creator 中使用和显示这些注释标记的步骤: 1. 自动补全 Doxygen 风格注释 在 Qt Creator 中,你可以这样操作: 在你的代码中,将光标放在

单细胞降维聚类分群注释全流程学习(seruat5/harmony)

先前置几个推文~ 单细胞天地: https://mp.weixin.qq.com/s/drmfwJgbFsFCtoaMsMGaUA https://mp.weixin.qq.com/s/3uWO8AP-16ynpRQEnEezSw 生信技能树: https://mp.weixin.qq.com/s/Cp7EIXa72nxF3FHXvtweeg https://mp.weixin.qq.

数据结构——双链表实现和注释浅解

关于双链表的基础部分增删查改的实现和一点理解,写在注释里~  前言              浅记   1. 哨兵位的节点不能被删除,节点的地址也不能发生改变,所以是传一级指针 2. 哨兵位并不存储有效数据,所以它并不是有效节点 3. 双向链表为空时,说明只剩下一个头节点(哨兵位)  List.h #pragma once#include<

A-loam源码注释-头文件lidarFactor.hpp

本篇博客是A-loam学习的笔记,用于SLAM初学者一起学习。 lidarFactor.hpp #include <ceres/ceres.h> #include <ceres/rotation.h> #include <eigen3/Eigen/Dense> #include <pcl/point_cloud.h> #include <pcl/point_types.h> #include

02 Shell Script注释和debug

Shell Script注释和debug 一、ShellScript注释 ​ # 代表不解释不执行 ​ 语法:# # 创建myshell.sh文件[root@localhost ~]# vi myshell.sh # 写入内容#!/bin/bash# 打印hello world(正确)echo "hello world"echo "hello 2" # 注释2(正确)echo