首页 存档 技术 查看内容

注释是恶魔,请不要再写一行注释

2018-3-30 13:00 |来自: 互联网 303 0

摘要: (点击上方公众号,可快速关注) 来源:leotsai 链接:http://www.cnblogs.com/leotsai/p/5096429.html 你可以从你们现在项目里面随便找几处注释,看看写注释的代码是不是存在如下两种毛病之一: 1. 命名不准 ...

(点击上方公众号,可快速关注)

来源:leotsai

链接:http://www.cnblogs.com/leotsai/p/5096429.html


你可以从你们现在项目里面随便找几处注释,看看写注释的代码是不是存在如下两种毛病之一:


  • 1. 命名不准确;

  • 2. 方法太长(超过50行)。


如果你找到的代码没有出现上面两种毛病而注释依然存在,那你再看看这个注释是否有实际意义,是不是这个注释不要也无所谓呢。


注释是恶魔


这个观点可能你第一次看到,你可能很难接受,因为写了这么多年的注释,你从未想过注释居然是恶魔,所以,你看到这个观点的时候可能就会本能的找出1000种理由反对(绝对不可能实现啊什么的),但是,这个观点并不是今天才出现,相信很多年前就有人提出,现在已被越来越多的人认可。


我第一次接受到这个观点还是从一个美国客户(十几年编程经验的技术大牛)那里,2011年,他让我们不要写注释。他当时主要意思是我们写的中式英语他猜起来太费劲,所以他后面又安慰我们说“好的代码是不需要注释的”,而我从此就将他后面那半句话奉为至宝。


注释是恶魔,它将我们的代码变得很难理解。就像本文开篇说的,你可以找找你们项目中出现注释的地方,要么命名不准确,要么方法太长。你可以随机找10处注释,看看有几处是恶魔,欢迎贴到评论中。


举一个以前项目中的例子吧,命名不准确的例子:


///
声明:文章版权归原作者所有 部分文章转自互联网 如有侵权请联系 [邮箱地址] 删除

路过

雷人

握手

鲜花

鸡蛋

相关分类

返回顶部