Re: [請益] 寫註解到底是不是好習慣
※ 引述《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
推
12/27 18:05,
5年前
, 1F
12/27 18:05, 1F
→
12/27 18:05,
5年前
, 2F
12/27 18:05, 2F
→
12/27 18:13,
5年前
, 3F
12/27 18:13, 3F
→
12/27 18:15,
5年前
, 4F
12/27 18:15, 4F
推
12/27 18:21,
5年前
, 5F
12/27 18:21, 5F
→
12/27 18:22,
5年前
, 6F
12/27 18:22, 6F
推
12/27 18:52,
5年前
, 7F
12/27 18:52, 7F
→
12/27 18:53,
5年前
, 8F
12/27 18:53, 8F
→
12/27 18:54,
5年前
, 9F
12/27 18:54, 9F
推
12/27 19:44,
5年前
, 10F
12/27 19:44, 10F
→
12/27 20:09,
5年前
, 11F
12/27 20:09, 11F
推
12/27 20:37,
5年前
, 12F
12/27 20:37, 12F
→
12/27 20:41,
5年前
, 13F
12/27 20:41, 13F
→
12/27 20:54,
5年前
, 14F
12/27 20:54, 14F
→
12/27 20:54,
5年前
, 15F
12/27 20:54, 15F
推
12/27 21:16,
5年前
, 16F
12/27 21:16, 16F
→
12/27 21:16,
5年前
, 17F
12/27 21:16, 17F
推
12/28 08:51,
5年前
, 18F
12/28 08:51, 18F
→
12/28 08:51,
5年前
, 19F
12/28 08:51, 19F
→
12/28 09:32,
5年前
, 20F
12/28 09:32, 20F
→
12/29 01:36,
5年前
, 21F
12/29 01:36, 21F
→
12/29 17:17,
5年前
, 22F
12/29 17:17, 22F
→
12/29 17:17,
5年前
, 23F
12/29 17:17, 23F
討論串 (同標題文章)