亚洲在线久爱草,狠狠天天香蕉网,天天搞日日干久草,伊人亚洲日本欧美

為了賬號安全,請及時綁定郵箱和手機立即綁定
已解決430363個問題,去搜搜看,總會有你想問的

在命名規范的情況 你還會寫注釋么?

在命名規范的情況 你還會寫注釋么?

DIEA 2018-12-28 23:15:44
比如一些方法// 封裝鏈路信息數據formatLinksInfo() {}// 獲取節點坐標數據getNodesPosition() {}// ip轉數字ipToNum() {}// 判斷元素是否全部選中isAllElemsActive() {}// 右鍵菜單選項itemContextMenu() {}if(target.classed('topo')){} // 拓撲圖情況if(target.classed('node')){} // 節點if(target.classed('link')){} // 鏈路比如像這種命名 不寫注釋感覺也能通過方法名或者類名 也能看懂,但自己還是都寫了 現在code review看來覺得很冗余問一下你們關于代碼注釋編寫原則是啥呢,能通過命名讀懂的都不寫么?
查看完整描述

1 回答

?
慕少森

TA貢獻2019條經驗 獲得超9個贊

  • 你不應該在每次調用方法的時候寫注釋,而是應該在聲明函數的地方寫注釋

  • 建議每個函數都寫相應的注釋

    • 你自己寫代碼存在主觀性,你覺得規范,其實不一定規范,或許可以說不一定全面;

    • 每個人理解方法是不一樣的,你覺得命名規范了,那也許是真的很規范,但是并不是所有人都能一下子看懂,如果要整個遍歷一下方法實現過程這是非常浪費時間的,別人看到一個函數應該立刻能從注釋和方法名知道這個函數是干什么的;

    • 函數名寫的再好,我也只能大概猜到這個函數是干什么的,但是我對函數的參數和返回值類型等信息一無所知

    • 總而言之,空間換時間,一次時間換以后的N次時間是非常值得的

  • 建議寫英文注釋,這樣review起來更加簡潔,不顯得那么格格不入,不要覺得什么自己或者其他人英文底子不好,網上各種英漢詞典,多寫英文注釋遇到不知道的還能多學幾個英文單詞


查看完整回答
反對 回復 2019-01-16
  • 1 回答
  • 0 關注
  • 379 瀏覽
慕課專欄
更多

添加回答

舉報

0/150
提交
取消
微信客服

購課補貼
聯系客服咨詢優惠詳情

幫助反饋 APP下載

慕課網APP
您的移動學習伙伴

公眾號

掃描二維碼
關注慕課網微信公眾號