※ 本文為 terievv 轉寄自 ptt.cc 更新時間: 2018-12-27 18:45:02
看板 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
※ 文章代碼(AID): #1S99sAO1 (Soft_Job)
※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1545903498.A.601.html
※ 同主題文章:
12-27 13:48 ■ [請益] 寫註解到底是不是好習慣
● 12-27 17:38 ■ Re: [請益] 寫註解到底是不是好習慣
12-29 04:36 ■ Re: [請益] 寫註解到底是不是好習慣
推 : 我從來不信命名就能知道作用 程式包含流程邏輯1F 12/27 18:05
→ : 不寫誰知道用三小邏輯去架構的
→ : 不寫誰知道用三小邏輯去架構的
→ : 見仁見智囉 我是偏向不管怎樣 寫個簡單的註解幫助後人維護3F 12/27 18:13
→ : 自己不管怎樣都會寫一下,怕接手的人拿刀來砍我XDDDDD4F 12/27 18:15
推 : 不寫註解 寫文件5F 12/27 18:21
→ : 或是commit message寫完整一點
→ : 或是commit message寫完整一點
--
※ 看板: terievv 文章推薦值: 0 目前人氣: 0 累積人氣: 133
作者 hidog 的最新發文:
- 自己出社會了,身邊女生大部分都出社會 大部分女生在擇偶的時候都會考慮另一半的收入 但最近身邊出現了一個特例 男生外表普普,談不上帥,不算8+9,非宮廟咖 28歲了還在啃老. (想當soho族,沒上過 …77F 24推 3噓
- 目前主流作法 當天告知裁員,資遣費,預告工資比照勞基法. 什麼?你說這違法? 不爽去告阿,笑你不敢跑法院 正確的資遣流程需要證明對方真的無法勝任工作 需要提出相關證據,資方確實有輔導過勞工. 但實務 …103F 24推 2噓
- 34F 7推
點此顯示更多發文記錄
回列表(←)
分享