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

news2024/12/23 14:34:21

在这里插入图片描述

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

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

🔫（一）注重代码质量

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

🔫（二）好的编码习惯

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

🔫（三）常写日志和注释

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

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

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