前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >代码到底需不需要注释?

代码到底需不需要注释?

作者头像
luoxn28
发布2019-12-12 16:48:20
5880
发布2019-12-12 16:48:20
举报
文章被收录于专栏:TopCoderTopCoder

编者注:关于代码代码需不需要注释,该有什么样的注释,不同的小伙伴有不同的见解,下面就开启代码注释的讨论吧 :)

好的代码需不需要注释,这个问题其实不能直接说需要或者不需要,因为要视情况而定。如果一段代码功能较为简单且独立,同时代码风格较好,是不需要注释的,因为代码本身已经足够说明其用意了(代码即注释);如果功能较复杂或者较为抽象,是需要合理注释的,方便他人阅读和快速理解代码逻辑。那么问题来了,什么是好的注释呢?就是简洁的表述自己当时的思考,即为什么,话句话说:应该表达“我的代码为什么要这么做?”,而不是表达“我的代码做了什么?”。必要的时候可以增加图形化说明,更加具体:

关于良好的编程风格,笔者这里推荐一本书:

记住一句话:

“程序员必须为了让人能阅读代码而书写代码,而机器执行只是顺便的。”

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2019-11-30,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 TopCoder 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档