你写代码爱写注释吗？程序员：我不写，但别人最好写！

知乎上有个关于“如何看待程序员不写注释这一现象”的讨论，浏览量达到78W+，热度很高。

可见大家对这个话题还是很感兴趣的，我浏览了大部分回答，发现大家的观点可以归纳为以下几点：

1️⃣不写注释可能会给自己和他人带来麻烦，因为随着时间的推移，即使是自己也可能会忘记代码的意图。

2️⃣如果代码的可读性很高，那么注释可能显得多余。

3️⃣只要有详尽的文档，代码就不需要注释。

4️⃣程序员在写代码时可能不愿意写注释，但在阅读别人的代码时，却希望对方有注释。

还有人总结了程序员最讨厌的四件事：写注释、别人不写注释、写文档、别人不写文档。

那么你最讨厌的事情是——

注释是代码的重要组成部分，但很多程序员却不愿意写，这是为什么呢？

01

程序员不写注释的原因

● 节约时间

一些程序员认为编写注释会消耗过多时间，因此经常忽略这一步骤。然而，精心编写的注释实际上是程序员对代码深层次理解和分析的反映，它对于增强代码的可读性和维护性至关重要。

● 认为注释可读性低

有些程序员认为代码本身应足够清晰，因此不需要额外的注释。但事实上，代码的解读通常需要特定的背景知识，而恰当的注释能够为那些不具备这些知识的人提供额外的指导和帮助。

● 偷懒

一些程序员可能出于懒惰或其他因素，选择忽略编写注释。这种行为不仅会降低代码的清晰度和可维护性，还可能对团队的协作精神和工作氛围造成不良影响。

02

如何解决这一现象

● 加强注释阅读的重要性

团队应当重视注释在提升代码质量和促进团队合作中的作用，鼓励开发者养成编写注释的良好习惯。例如，在代码审查过程中，应当特别留意注释是否规范、详尽，确保能够为代码的理解和维护提供有效支持。

● 提供更多的样板注释

公司可以制定一套代码编写规范和注释样板，为程序员提供标准化的注释模板。这种做法不仅能够简化注释的编写过程，降低其难度，而且有助于确保注释的一致性和质量。

● 强制要求写注释法规

当新成员加入团队或新任务被分配时，团队可以强制要求程序员在提交代码前添加必要的注释，这有助于逐步培养团队成员对注释重要性的认识和习惯。

● 提高代码可读性

程序员应当致力于提升代码的可读性，确保代码结构条理清晰、变量和函数命名规范，遵循良好的编程风格可以减少对注释的依赖。

● 使用适当的编码工具和插件

一些编码工具和插件具备自动生成注释的功能，这可以显著减少程序员手动编写注释的工作量，还可以提高编写注释的效率。

● 鼓励交流与分享

团队应该鼓励成员之间的交流与分享，以增强程序员对注释重要性的认识，并从中获得实际的好处。

Python入门学习资料

1.Python系统学习路线图

首先，对于没有学习方向，知识不体系的人，我把我工作几年整理的学习路线分享给大家，做一个借鉴作用，还不知道怎么学习的人可以直接照着我这个学习路线一个个的去学习，知识不体系的人可以参考下我整理路线的方式，总之希望能够帮到你们！

2.Python必备开发工具

3.看视频进行系统学习

先在网上康康达人分享的视频、干货，通俗易懂，形成初始概念；你会发现博主们在进阶成大神之前他们的学习途径有哪些，找到适合自己风格的课程；

不过这样学习技术比较杂乱，所以通过更加系统的视频来学习，效果更好，也更全面。

4.实战案例

光学理论是没用的，要学会跟着一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。

最后

如果你也想自学Python，可以关注我。我会把踩过的坑分享给你，让你不要踩坑，提高学习速度，还整理出了一套系统的学习路线，这套资料涵盖了诸多学习内容：开发工具，基础视频教程，项目实战源码，51本电子书籍，100道练习题等。相信可以帮助大家在最短的时间内，能达到事半功倍效果，用来复习也是非常不错的。

希望这篇文章对你有帮助，也希望能帮到大家，因为你我都是热爱python的编程语言爱好者。

————————————————

↓↓↓↓

资料获取：已打包，添加文末 Python笔记领取即可获取！