代码与注释

讨论了代码注释的重要性及是否应该以高标准来促进个人成长,指出代码清晰度与注释之间的关系,以及如何平衡代码理解和注释效率。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

         代码应该足够清晰以至能够自我描述,能够清楚表达做什么以及怎么做,但是代码往往无法表达为什么这样做。因为受环境影响,代码所体现的设计不一定是最优的方式。写满注释的代码与没有注释的代码一样糟糕,因为阅读代码的难点在于理清代码的作用与意图,而阅读注释的难点在于代码和描述代码的注释之间存在着语义距离,这种语义距离导致读者迷惑和误解。

        常听到要多写注释观点,的确存在这种情况,就是团队开发中各人的编程能力参差不齐,对代码的理解能力差异很大,为了迁就大部分成员,应该多写注释。但试问一下:是应该降低标准来适应自身还是应该以高标准来促使自身不断改进?我们的精力是不是被放错了地方?

        欢迎大家发表意见。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值