程序员不撰写代码注释和文档的十大理由

简介: 在软件开发的世界中,撰写代码注释和文档通常被认为是一项重要的工作,它可以帮助其他开发者理解你的代码,更容易地维护和扩展它。然而,在实际操作中,很多程序员却选择不写注释或文档。以下列出了程序员们在实践中经常提到的十大理由,这些理由不仅揭示了他们对于撰写文档和注释的观点,也反映出软件开发行业中一些深层次的问题。

在软件开发的世界中,撰写代码注释和文档通常被认为是一项重要的工作,它可以帮助其他开发者理解你的代码,更容易地维护和扩展它。然而,在实际操作中,很多程序员却选择不写注释或文档。以下列出了程序员们在实践中经常提到的十大理由,这些理由不仅揭示了他们对于撰写文档和注释的观点,也反映出软件开发行业中一些深层次的问题。

图片.png

  1. 我们并非开发面向外部的 SDK,所以撰写文档似乎毫无必要。再者,写文档并不能作为 KPI 的一部分。

  2. 实际上,是因为工期过于紧迫。如果有充裕的时间,我甚至愿意增加单元测试。但现实是,刚刚完成一个项目,就有新的任务立刻接踵而至,没有时间让我们稍作休息。

  3. 有的时候,我们确实有文档,但却无法及时更新,全都是过时的内容。这种情况下,有文档反而不如没有,查阅文档往往不如直接看代码,但却让人误以为有文档就很方便。

  4. 在我的代码中,我几乎不写注释,API文档我会写在 wiki 中,代码规范,命名也规范。当你的代码规范、命名规范时,其实没有必要写注释。目录名、函数名和变量名就是最好的注释。

  5. 如果你的架构设计得很好,代码易读、易扩展,任何人都可以接手。这就让你成为一个“可有可无”的人。

  6. 如果你的代码写得很好,基本上没有 bug,而你又每天都不需要加班,你就被视为工作态度不积极的人。

  7. 如果你的代码写得很差,bug 层出不穷,每天都必须加班,你就成了公司的中坚力量。

  8. 如果你的架构一片混乱,除了你自己没有人敢接触你的代码,那你就是公司的重要人物,没有你,项目就会崩溃。

  9. 撰写文档和注释,需要体谅开发者的感受。正常的开发工时,我们至少需要一半的时间来写文档。如果没有这个时间,自然就不能写,这是毫无疑问的。

  10. 写注释是为了将来自己查看,而不是给后续接手的人看。如果自己都能看懂,就没必要写注释。代码的原则是:没有注释也能看懂的代码,才是最好的代码。

图片.png

以上是程序员们不写代码注释和文档的十大理由,这些理由充分反映出他们在实际工作中的困扰和压力。但是,这并不意味着我们就可以忽视文档和注释的重要性。尽管在某些情况下,这些理由可能有一定的道理,但是好的代码注释和完善的文档无疑可以使我们的工作更加有效率,使其他开发者更容易地理解和维护我们的代码。为此,我们需要寻找一个平衡点,以满足项目的需求,同时也尽可能地减少对开发者的负担。

目录
相关文章
用 ChatGPT 编写英文技术文章要自己多审核,否则容易被严谨的同行喷
用 ChatGPT 编写英文技术文章要自己多审核,否则容易被严谨的同行喷
|
1月前
|
项目管理
技术方案撰写之道:实用技巧与方法
本文探讨了如何撰写技术方案,强调了考虑方案的相关方、关键指标、目标受众和预期收益的重要性。文章提出了写作框架应清晰、表达生动、具有美感,并指出好的方案应实现共赢、系统规划和显著效益。写技术方案时,需明确问题、深入分析需求、设定合理目标、设立度量标准、专业设计方案、规划执行路径并有效项目管理,确保方案的成功实施和收益。
181 0
|
1月前
|
算法 芯片
嵌入式工程师如何快速的阅读datasheet的方法
嵌入式工程师如何快速的阅读datasheet的方法
86 0
|
9月前
|
存储 JavaScript 前端开发
关于缺少编程基础的朋友想转行 ABAP 开发岗提出的一些咨询问题和解答
关于缺少编程基础的朋友想转行 ABAP 开发岗提出的一些咨询问题和解答
|
存储 Java 程序员
如何写好技术文档——来自Google十多年的文档经验
如何写好技术文档——来自Google十多年的文档经验
464 2
如何写好技术文档——来自Google十多年的文档经验
|
JavaScript 搜索推荐 前端开发
软件工程师文档写作最佳实践
软件工程师文档写作最佳实践
153 1
软件工程师文档写作最佳实践
网友提问:当我要使用一个陌生的标准BAPI,我可以去哪里找到比较详尽的文档指导一类的资料
网友提问:当我要使用一个陌生的标准BAPI,我可以去哪里找到比较详尽的文档指导一类的资料
网友提问:当我要使用一个陌生的标准BAPI,我可以去哪里找到比较详尽的文档指导一类的资料
略谈为什么要重视文档写作
略谈为什么要重视文档写作
176 0
略谈为什么要重视文档写作
【翻译】资深工程师代码之外的必备技能清单
草草翻译~原文:https://skamille.medium.com/an-incomplete-list-of-skills-senior-engineers-need-beyond-coding-8ed4a521b29f会议技:说的是如何组织和主持一个会议,和做一个在会议上说得最多的人是两回事哦~文档技:如何写一份设计文档,接受反馈并在一个合理的时间段内落地完善。辅导技:如何辅导一个新入职同
191 0
|
程序员 测试技术
阅读优秀代码是提高开发人员修为的一种捷径
导读:原文作者Alan Skorkin是一名软件开发人员,他在博客《Why I Love Reading Other People’s Code And You Should Too》中分享对软件开发相关的心得。
1184 0