好的代码注释究竟应该是什么样的?!!!

先看段子:

//写这段代码的时候,只有上帝和我知道它是干嘛的

//现在,只有上帝知道 

 // 神奇。勿动。

       我们讨论好的代码究竟应该是什么样的?,是密密麻麻的注释,看着中英文夹杂,恶心至极。还是什么都没有,我认为更应该偏向于后者,但是后者很难做到,好的代码注释应该是在二者之间吧。

  • 首先应该强调的就是错误的认识,总是有一些人在乱说,胡乱传递,人云亦云。诸如我经常听到的一句话,代码注释应该达到80%。

  • 这是典型的误导,这种代码价值观从起步你就偏了,因为你没有关注代码本身的质量,而是靠大量注释去解释,但是这种往往是让维护者依旧看的一头雾水。

代码应该自注释。

  is_open  就比   open、is_open_close 强,因为我在看代码的时候永远get不到open和is_open_close 是究竟开了还是关了,但是相反 !is_open 这99%的人是明白的。

out_

 

 

 

 

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值