注释不宜过头

我一个同学,称自己的每一句代码都有注释,并以此为荣。

其实,注释的目的是什么呢?是为了别人接手这个程序时,能很快理解程序;或者长时间之后,帮助自己回忆。

我不知道现在有多少程序员在开始写代码之前,会认认真真的对程序进行设计。是理清了头绪再敲键盘,还是不管三七二十一,写了,然后再拼命调试,拼命改……

良好设计的代码脉络清晰,模块划分合理,每个模块的逻辑足够简单。阅读这样的代码就如同阅读小说一样顺畅,代码本身说明了一切!注释完全是多余,画蛇添足!

你见过这样的小说吗?每一段边上都再加一段文字说明这一段小说写了什么(评点本除外)。小说只有开头会有一个概要的介绍。

注释也一样,不需要对代码注释,需要注释的只是某一个模块的说明。

如果自认为目前达不到“良好设计”的水准,可以先多写一些注释,也没关系的,但不要以此为荣,让自己有一个努力的方向,总比既无注释,设计又糟糕好得多。

总之,优良的设计+良好的代码风格=较少的注释

当你发现不得不写很多注释的时候,这时就是检查自己设计是否合理的时机。

  • 0
    点赞
  • 0
    收藏
  • 打赏
    打赏
  • 0
    评论

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

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
©️2022 CSDN 皮肤主题:大白 设计师:CSDN官方博客 返回首页
评论

打赏作者

Nicrosoft

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值