作者hidog (.....)
看板Soft_Job
標題Re: [請益] 寫註解到底是不是好習慣
時間Thu Dec 27 17:38:16 2018
※ 引述《sec5566 (sec)》之銘言：
: 以前上課跟書本都提到寫註解，
: 但是我看資深同事還有接手的程式碼，
: 都沒有註解，只有我在寫，
: 還被主管念過寫註解沒必要，
: 命名好就夠了，
: 是我觀念落伍了嗎？
有一派看法是code寫的簡潔易讀,靠命名就能知道作用,
寫太多註解沒好處. (因為註解也是需要維護的)
有一種例外
當code充斥大量work around的時候,一定要加註解,避免後面維護的人踩地雷
有些work around你不寫註解,真的沒人看得懂.
建議是先看你的工作環境
如果你的專案維護都有給足夠的時間開發,會定期重構,閱讀性不差,
也有寫unit test等等,這種情況下我同意沒必要寫註解.
反之,就快逃吧.....
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 118.160.97.186
※ 文章網址: https://webptt.com/m.aspx?n=bbs/Soft_Job/M.1545903498.A.601.html
1F：推 KanzakiHAria: 我從來不信命名就能知道作用 程式包含流程邏輯 12/27 18:05
2F：→ KanzakiHAria: 不寫誰知道用三小邏輯去架構的 12/27 18:05
3F：→ hidog: 見仁見智囉 我是偏向不管怎樣 寫個簡單的註解幫助後人維護 12/27 18:13
4F：→ windlll: 自己不管怎樣都會寫一下，怕接手的人拿刀來砍我XDDDDD 12/27 18:15
5F：推 fukinhot: 不寫註解 寫文件 12/27 18:21
6F：→ fukinhot: 或是commit message寫完整一點 12/27 18:22
7F：推 wotupset: 寫註解就像文言文的注疏 寫得好可以永世流傳 12/27 18:52
8F：→ wotupset: 但沒有人會給白話文寫注疏 因為年代不同 語言結構改良 12/27 18:53
9F：→ wotupset: 起承轉合寫得好 自然不用寫註解 12/27 18:54
10F：推 twntwn: 程式碼只能表達 做了什麼 不能表達 為什麼做 12/27 19:44
11F：→ MOONY135: 寫註解我都當作功德... 12/27 20:09
12F：推 oneheat: 接口會寫用法跟說明，歷史因緣更多應該寫在commit log中 12/27 20:37
13F：→ shortoneal: 也有遇過改code改邏輯不改註解的，看的時候黑人問號 12/27 20:41
14F：→ THEWORLDS: 命名可以看得出來就很簡單阿 小專案 沒啥設計模式在 12/27 20:54
15F：→ THEWORLDS: 妳叫學生專案寫注解大家都黑人問號拉 這不用辯了 12/27 20:54
16F：推 maxumin: 我是一定寫註解，commit log對新接手，幫助的不大，歷史 12/27 21:16
17F：→ maxumin: 兩百份，追到死還追錯，全域變數東西南北都有也是辛苦啊 12/27 21:16
18F：推 acer1832a: 我不排斥寫註解，但很討厭每一行都要寫註解才看得懂的 12/28 08:51
19F：→ acer1832a: 人 12/28 08:51
20F：→ rofellosx: 先別說讓人接手 自己寫的三個月後還能看懂再說.. 12/28 09:32
21F：→ viper9709: 推一樓 12/29 01:36
22F：→ TAKADO: 個人覺得最恐怖的是盲目相信 “code本身就是註解”+”每個 12/29 17:17
23F：→ TAKADO: class/method不可以超過N行” 的教徒寫來的東西。 12/29 17:17