Re: [請益] 寫註解到底是不是好習慣

看板Soft_Job作者Ghamu (貓丸)時間5年前 (2018/12/29 04:37)推噓5(6推 1噓 3→)

留言10則, 8人參與討論串8/24 (看更多)

個人淺見註解是可恥的代表你程式不夠乾淨變數函式名稱詞不達意只能靠註解補完最近手上接到外包的程式碼有一個核心處理封包差不多200行程式碼裡面做什麼呢？他有好心寫上註解 //處理messages類型 A . . . //處理類型B . . . //..............C 欸..... 那實際上不就該是處理類型A(); 處理類型B(); 處理類型C(); 嗎？？？當註解變多時或開始寫註解時就是一個該refactoring的信號了當然說可恥是有點偏激主重點在於說應該盡力窮盡所能讓程式碼即註解而不是去依賴註解註解雖然可恥但是有用在以下情形我還是會註解 1.英文不夠好有時候想不到該怎麼描述才清楚畢竟不是英文母語只好寫上註解等未來有緣人幫忙修改 2.變數名稱函式因為單字太長冷僻縮寫我會加上註解別讓下一個人猜 3. 非正規解法詭異做法時最近剛好遇到Java rename 會失敗的問題一位資深的前輩說是因為裡面一連串動作有一個錯他就整個錯建議把他拆開來做先複製改名 move 等等如果自己寫一個rename () 把這些步驟放進去下一個人看到一定會疑惑為什麼要自己重寫吧？這時候就要加上註解描述是因為有那個風險才做此改變簡單的說程式碼就是註解註解不要重複描述程式碼註解要能提供程式碼以外你的設計意圖 ----- Sent from JPTT on my Sony F5321. -- ※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 114.25.229.193 ※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1546029421.A.35E.html

推

orange0319

12/29 09:09, 5年前 , 1^F

12/29 09:09, 1^F

推

Ryuusei

12/29 09:18, 5年前 , 2^F

12/29 09:18, 2^F

→

Ryuusei

12/29 09:18, 5年前 , 3^F

12/29 09:18, 3^F