【程序员对代码注释可以说是又爱又恨又双标……你是怎么看待程序员不写注释这一事件的呢?】2023-10-10

关于给代码写注释这事不单纯,为何不单纯?因为代码千差万别,有些可以不用写注释,而有些则写注释是必要的,而有些可有可无在某种程度上时。

就我自己来说,学程序之初连输入输出语句都要写注释,而到熟悉后就司空见惯了就不需要写注释;初学也有不惯写注释的习惯,认为写注释麻烦就不写,然而,遇到逻辑非单一情况下,发现写注释很有帮助,这时就觉得注释很好用,有助于分析逻辑和存在的问题,于是有一段时间不那么讨厌写注释,当代码写在万行内时,逐渐阅读代码比较熟悉后,又懒得写注释,虽然知道注释的好处,这只能说明一个问题,就是图方便,懒得去写注释,并非注释不好,也非注释本身存在问题。当写代码量过万后,逐渐熟悉阅读代码后,当代码量少与逻辑单一时完全不需要写注释,如单一判断:if(){};这就不需要写注释了;渐渐地if(){}else{};也不需要写注释了;渐渐地if(){}else if(){}else{}也不需要写注释了,这就好比上幼儿园一般,从小班到中班到大班,渐渐提升代码阅读能力,就可以完全摆脱写注释的麻烦了,于是,有一种升级般的快乐与免写的解脱感。

接下来就是写一个能运行的软件工程了,不似初学乍练的只写个片段或函数。例如写个网站,写个Win界面的可独立运行的软件;随着工程代码量越来越多,调用函数越来越多,会发现代码阅读开始变得费尽起来,这时又想起了注释的好处,于是又开始写注释,当然已经不是每句写注释的那种了,而是觉得在关键处写注释有助于对工程各处衔接或功能的理解了,也便于不同时间点上的违法方便了;同上一样道理,也就是从量变到质变的真理一样,当代码量超过某量,对工程熟悉程度的不懂提高,渐渐地又开始不愿写注释了,写的注释越来越少了,渐渐地写注释这事也就停止了,这就好比上小学经历各年级一样道理,逻辑和书写上日趋完善,渐渐地熟悉并摆脱注释所要花费时间和精力,也觉得写注释没必要了。

接下来如果还从事代码编写,就进入了中学时代,如同学校班级升班一样道理,写代码和阅读代码越来越顺畅,越来越驾轻就熟地,渐渐地又开始厌倦写注释了,干脆就不写注释了;这时开始逛论坛了,起初逛论坛为了提问或借鉴,渐渐有回复了,就好比这时从初中经历各班次到高中各班次,渐渐地从提问借鉴到有能力可以辅导幼儿班和小学班一样;在论坛我走的是提问+借鉴+回复的模式,于是热衷于逛论坛了,我的经验是回复就是学习,于是,没了提问,尽是回复了,虽然,有些回复早已经是重复多遍了,然而,就像是国学语文卖油翁一样道理,虽然重复也能获益,开始从幼稚的思维净化到简练,代码都是凝聚了逻辑上和书写上的反复推敲千锤百炼般的尽量做到简练,讨厌啰嗦讨厌注释。

终于考上大学了,在编程的路上,随心所欲,思路敏捷,代码熟练,闭着眼睛都能轻松完成各种函数,各种复杂的逻辑处理,或一挥而就,或稍加思索,被难倒的情况机会不大了,这时似乎忘记了注释;只有当回复有要求注释时才写,渐渐地写的约简约了,这时不是为了自己写注释,同时也从经验上鼓励别人写注释,从析题到语句,纯属经验之谈,偶尔高兴了就自己写点析题和注释用于算法也是很便利的,当然不写也无妨,就是可有可无的状态,大多不是为了自己而写。

总结,写注释这事,其实经历各阶段,波浪式的方式,因此,不能论孰是孰非的,我的建议是根据需要看情况;好了,文章大概如此,基本也是一挥而就地,肯定有不足置处,权当以后有评论再补充了,至此,千言已就,获益有期。

你可能感兴趣的:(笔记,经验分享,百度)