为什么越来越多的程序员不写注释?注释应该怎么写?

本文探讨了为何代码注释在项目中越来越少的现象,主要原因是程序员工作环境的压力、对代码质量的追求以及缺乏注释规范。同时,提出在复杂逻辑、晦涩算法、非常规写法等情况下,注释仍然必不可少,并分享了作者所在团队的注释规范,强调注释应有节制、有标准地添加。
摘要由CSDN通过智能技术生成

现在的项目开发里,代码注释就像程序员的头发,越来越少。

尤其是国内,这种现象不仅是在小公司小团队中司空见惯,就算在大公司,以及大团队中的开源项目里,也是屡见不鲜。

上图是我在阿里的 Druid 项目源码里截的。DruidDataSource 是 Druid 重度使用的核心类,非常关键,可是哪怕这种关键的核心类,也见不到什么注释。

没有注释对我们读代码带来了很多的不便之处。就像扔给你一个数码产品,上面堆叠着密密麻麻的功能按键,但是却没有给你说明书。

那为什么代码注释消失了呢?

我尝试总结一下原因:

1. 国内程序员的职业环境对加注释不友好

在国内这种环境里,程序员们每天在苦闷的 996 中挣扎,各种大活小活不断地做着,正常写代码都忙得不可开交,加注释更是进一步提升了工作量,没人喜欢自己给自己加工作量的。

咱们想想,在费劲巴拉地写完一大堆代码之后,经过反复自测修改之后,好不容易调通了,脑子已经晕乎乎的了,你此时会有多大心思去写这段注释呢?

又再想想,你可能想着要给代码加注释呢,突然这边产品拉你开会,又或者那边运营告诉你,需求变了,刚写好的代码还得再改改……此时,你还有给代码加注释的念头吗?

另外,注释这事儿,写好了是很费精力的。一般来说,一段好的注释,要能在有限的行数之内说明出:被它注释的代码到底做了什么,是个怎样的概念以及为什么会写这段代码

写注释麻烦不说,关键是注释还不算咱们程序员的工作量。

程序员的工作是把业务用程序实现,工作结果里不看你注释了多少代码,也不看你注释写的好还是坏,只看你的程序是不是写完了,满足了需求没有,会不会上线出什么问题。

至于注释,它滚出了程序员兄弟们的 KPI。有多少公司能像 Google 那样去 Review 代码的?BAT 有一个算一个,都差点意思。

所以,国内程序员们糟糕的环境,是代码注释少的首要原因。

2. 看待注释的方式出现了变化

Java 是一门面向对象的语言,从它出世以来,业界就不断地为 Java 制定了数不清的规范。

在 20

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值