首頁猿問在命名規(guī)范的情況你還會(huì)寫注釋么？

在命名規(guī)范的情況你還會(huì)寫注釋么？

JavaScript

DIEA 2018-12-28 23:15:44

比如一些方法// 封裝鏈路信息數(shù)據(jù)formatLinksInfo() {}// 獲取節(jié)點(diǎn)坐標(biāo)數(shù)據(jù)getNodesPosition() {}// ip轉(zhuǎn)數(shù)字ipToNum() {}// 判斷元素是否全部選中isAllElemsActive() {}// 右鍵菜單選項(xiàng)itemContextMenu() {}if(target.classed('topo')){} // 拓?fù)鋱D情況if(target.classed('node')){} // 節(jié)點(diǎn)if(target.classed('link')){} // 鏈路比如像這種命名不寫注釋感覺也能通過方法名或者類名也能看懂，但自己還是都寫了現(xiàn)在code review看來覺得很冗余問一下你們關(guān)于代碼注釋編寫原則是啥呢，能通過命名讀懂的都不寫么？

查看完整描述

1 回答

慕少森

TA貢獻(xiàn)2019條經(jīng)驗(yàn) 獲得超9個(gè)贊

你不應(yīng)該在每次調(diào)用方法的時(shí)候?qū)懽⑨?，而是?yīng)該在聲明函數(shù)的地方寫注釋
建議每個(gè)函數(shù)都寫相應(yīng)的注釋

你自己寫代碼存在主觀性，你覺得規(guī)范，其實(shí)不一定規(guī)范，或許可以說不一定全面;
每個(gè)人理解方法是不一樣的，你覺得命名規(guī)范了，那也許是真的很規(guī)范，但是并不是所有人都能一下子看懂，如果要整個(gè)遍歷一下方法實(shí)現(xiàn)過程這是非常浪費(fèi)時(shí)間的，別人看到一個(gè)函數(shù)應(yīng)該立刻能從注釋和方法名知道這個(gè)函數(shù)是干什么的;
函數(shù)名寫的再好，我也只能大概猜到這個(gè)函數(shù)是干什么的，但是我對(duì)函數(shù)的參數(shù)和返回值類型等信息一無所知
總而言之，空間換時(shí)間，一次時(shí)間換以后的N次時(shí)間是非常值得的