一段代碼的注釋阔籽,最重要的是兩點(diǎn):
1 注釋要寫它存在的原因甫贯。
這段代碼存在是因?yàn)榧嫒轂g覽器某個(gè)版本涛漂,還是為了后臺的特殊返回妥協(xié)處理一下,還是因?yàn)橐岣咝阅茏龅膬?yōu)化氢橙,或是避免某個(gè)坑酝枢。
只有寫明了原因,在以后別人修改或重構(gòu)的時(shí)候悍手,才能判斷當(dāng)初存在的原因是否已經(jīng)不復(fù)存在帘睦,可以去掉。
2 要寫這一塊代碼是在干什么坦康。
有時(shí)候不可能每段都把原因?qū)懙暮芮宄⒏叮蔷鸵颜w是在干什么寫出來,一句話總結(jié)一下滞欠。因?yàn)殚喿x別人代碼經(jīng)常會(huì)沒句都清楚古胆,合在一起不知道干什么了。千萬不要“翻譯”一代碼筛璧,比如“取字符串的最后兩位”