《编程匠艺》读后感
最近花了些心思读了篇《编程匠艺》,便写写读后感吧。
这本书相对于别的技术类的书呢,浅显易懂,读起来没有任何酸涩感,就犹如看小说一般,走马观花似的便读完了。最大的感触吧,便是它让我更加坚定了“坚决不写注释”的执拗。
“注释”这玩意
书里讲呢,一名优秀的程序员便应该也是一名作家,写出来的代码要像诗歌一样优美。
我们给代码打上注释,便是让后人亦或者是未来的自己看得懂自己的代码,而如果,我们的代码,一眼就能看出来这一行是做什么,那一行是做什么,注释又有何意义呢?
趋于完美的代码固然是不需要注释的。当然,并不是所有的代码都可以让“读者”明白它的本意,所以,即使规避了99.9%的注释,仍会有那么0.1%的代码需要我们打上注释。
但是!注释,到底该怎么些呢?
注释,是为了让“读者”明白这段代码是在做什么。所以我们的注释,应该解释Why,而不是解释How。
举个栗子
前不久,有一个需求:在上传Base64化的图像前,对数据大小进行检验,大于3M的不予上传。于是便有了如下代码:
1 | if (parseInt(response.data.length/1048576) >= 3) { //1048576 = 1024 * 1024 |
这里只解释了1048576的来历,而并没有提出如何算出数据大小。但是却可以让“读者”理解。(好吧貌似这样只能让聪明点的“读者”理解了。)