一段代码的注释,最重要的是两点:
1 注释要写它存在的原因。
这段代码存在是因为兼容浏览器某个版本,还是为了后台的特殊返回妥协处理一下,还是因为要提高性能做的优化,或是避免某个坑。
只有写明了原因,在以后别人修改或重构的时候,才能判断当初存在的原因是否已经不复存在,可以去掉。
2 要写这一块代码是在干什么。
有时候不可能每段都把原因写的很清楚,那就要把整体是在干什么写出来,一句话总结一下。因为阅读别人代码经常会没句都清楚,合在一起不知道干什么了。千万不要“翻译”一代码,比如“取字符串的最后两位”
网友评论