正文

为什么码农不写注释了

(2019-09-29 07:06:07) 下一个

现在写代码已经不流行写注释了。就像小学生读的书需要汉语拼音,到了中学以上就不要了。

为什么注释不重要了?

因为注释所起的功能,都被不同的方式替代了。

比如,以前代码的开头需要介绍下主要功能,现在有Design Document,可以把本来放在注释的东西放到那里面。

现在代码需要写成可分享的模块,你的代码大体包含两个部分,界面与实现。

实现里面不必加注释,因为没人关心。对别人来说,这是黑箱,人家从不打开。

界面不必要加注释,用Optional Parameter,throw Exception等来替代。

代码可以写得Self-Explanatory。

一是变量名、函数名尽量用长一些。

二是长一点的函数都要拆成短的,用合适的名字。

要避免注释,最重要的技术是Refactoring,如果发现函数需要承担以前不能承担任务的时候,要把名字及时Refactoring。

再加上Behavior Driven Development,可以用类似口语的语言来写测试。

不着注释,尽得风流。

[ 打印 ]
阅读 ()评论 (0)
评论
目前还没有任何评论
登录后才可评论.