每天学习的重要性-对代码的注释看法

对一帮新人在讲代码标准时,恰巧一位职位是领导的人进来视察,在讲到关于注释时,她很激动的强调要求写很详细的注释来解释代码,而这正好和我讲解的方向相反,为此同其辩解了一番。

对话内容大概如下:

我:代码的注释还是越少越好。

领导:没有注释,我根本就看不懂这里写的是什么,这是很差的代码。

我:通过方法的名字,变量的名字,及代码的执行顺序就可知道。

领导:那不是要一层一层的看代码,才知道,有了注释,我直接看注释就知道这是做什么的了,也能很好的向领导,新人解释代码。

我:用代码来代替注释并不复杂。复杂的代码通过不断的抽取,优化成小方法,命名做到见名知义,根据逻辑组织方法的排列即可简单明了。而注释会有严重和当前代码滞后的可能性,这时注释反倒成了错误的指向。对于要看懂某段代码在干什么,看这些方法的名字,变量的名字就知道在做什么了。但你要想知道这个功能的根本原理是什么样的,那就需要一层一层的链接下去,仔细查看代码才行,靠注释是没有用的,注释的坏处刚刚有讲到,也不可能在每次用到某个方法时,就写一大段的注释详细的解释代码的实现细节,其根本原理是什么,这不是有点怪怪的。对于很多框架来讲,他们并 不希望你去了解实现的原理是怎么样的,你只要知道调用这个方法会产生出什么样的效果来就可以了。你若真要想知道原理,那自己去看API,看代码。同理,我们写代码也要做到这样子。

领导:我还是不赞同。这样我看不懂代码,要不找副总问问,不要写注释好不好?要不你们来做设计好了。。。

我(无语,拿副总压我):我没有说不要注释,我只是说在关键的地方注释即可,其余的可通过代码来代替注释,看代码也是有一定的门槛的。

。。。


真搞不懂,既然做设计那还看什么代码,要看代码那就要掌握基本的框架,语言知识。想做设计,又要懂代码,那只能通过学习提升自身,才是根本的解决之道。不想学习,只躺在资历或过去经验的基础上,来要求别人写出他们想要的代码来是不可取的,殊不知知识早已更新换了好几代了。不进必退,终究会被后人取代。

坚持每天的学习,与时俱进,才会不断的前进,才能立于不败之地。成长起来,不要让自己只是变老。



發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章