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

[hidog (.....)]

※ 引述《sec5566 (sec)》之銘言：
: 以前上課跟書本都提到寫註解，
: 但是我看資深同事還有接手的程式碼，
: 都沒有註解，只有我在寫，
: 還被主管念過寫註解沒必要，
: 命名好就夠了，
: 是我觀念落伍了嗎？

有一派看法是code寫的簡潔易讀,靠命名就能知道作用,
寫太多註解沒好處. (因為註解也是需要維護的)

有一種例外
當code充斥大量work around的時候,一定要加註解,避免後面維護的人踩地雷
有些work around你不寫註解,真的沒人看得懂.

建議是先看你的工作環境
如果你的專案維護都有給足夠的時間開發,會定期重構,閱讀性不差,
也有寫unit test等等,這種情況下我同意沒必要寫註解.

反之,就快逃吧.....



--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 118.160.97.186
※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1545903498.A.601.html
推 KanzakiHAria: 我從來不信命名就能知道作用  程式包含流程邏輯
→ KanzakiHAria: 不寫誰知道用三小邏輯去架構的
→ hidog: 見仁見智囉  我是偏向不管怎樣 寫個簡單的註解幫助後人維護
→ windlll: 自己不管怎樣都會寫一下，怕接手的人拿刀來砍我XDDDDD
推 fukinhot: 不寫註解 寫文件
→ fukinhot: 或是commit message寫完整一點
推 wotupset: 寫註解就像文言文的注疏 寫得好可以永世流傳
→ wotupset: 但沒有人會給白話文寫注疏 因為年代不同 語言結構改良
→ wotupset: 起承轉合寫得好 自然不用寫註解
推 twntwn: 程式碼只能表達 做了什麼 不能表達 為什麼做
→ MOONY135: 寫註解我都當作功德...
推 oneheat: 接口會寫用法跟說明，歷史因緣更多應該寫在commit log中
→ shortoneal: 也有遇過改code改邏輯不改註解的，看的時候黑人問號
→ THEWORLDS: 命名可以看得出來就很簡單阿 小專案 沒啥設計模式在
→ THEWORLDS: 妳叫學生專案寫注解大家都黑人問號拉 這不用辯了
推 maxumin: 我是一定寫註解，commit log對新接手，幫助的不大，歷史
→ maxumin: 兩百份，追到死還追錯，全域變數東西南北都有也是辛苦啊
推 acer1832a: 我不排斥寫註解，但很討厭每一行都要寫註解才看得懂的
→ acer1832a: 人
→ rofellosx: 先別說讓人接手  自己寫的三個月後還能看懂再說..
→ viper9709: 推一樓
→ TAKADO: 個人覺得最恐怖的是盲目相信 “code本身就是註解”+”每個
→ TAKADO: class/method不可以超過N行” 的教徒寫來的東西。