※ 本文為 terievv 轉寄自 ptt.cc 更新時間: 2018-12-27 18:41:21
看板 Soft_Job
作者 標題 [請益] 寫註解到底是不是好習慣
時間 Thu Dec 27 13:48:31 2018
以前上課跟書本都提到寫註解，
但是我看資深同事還有接手的程式碼，
都沒有註解，只有我在寫，
還被主管念過寫註解沒必要，
命名好就夠了，
是我觀念落伍了嗎？
-----
Sent from JPTT on my Sony H4331.
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 223.140.72.67
※ 文章代碼(AID): #1S96UnAr (Soft_Job)
※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1545889713.A.2B5.html
※ 同主題文章:
● 12-27 13:48 ■ [請益] 寫註解到底是不是好習慣
12-27 17:38 ■ Re: [請益] 寫註解到底是不是好習慣
12-29 04:36 ■ Re: [請益] 寫註解到底是不是好習慣
※ 編輯: sec5566 (223.140.72.67), 12/27/2018 13:48:43
--
推 : 想不寫註解有很多前提，而這個前提不容易達到1F 12/27 13:54
推 : 好的代碼很少在寫註解，或者說，code都寫不好了，為什麼2F 12/27 13:55
→ : 會覺得註解會寫的好呢？
→ : 會覺得註解會寫的好呢？
→ : 有寫註解讓其他人比較省時吧 五六行的程式 一句註解4F 12/27 14:02
→ : 就知道在幹嘛了 有時候哪有時間在那邊一行一行看
→ : 就知道在幹嘛了 有時候哪有時間在那邊一行一行看
推 : 需要很多註解常常不是件好事6F 12/27 14:07
推 : 寫什麼註解？貼一段來看一下為什麼需要註解7F 12/27 14:11
推 : 覺得自己寫的很好就不寫註解 這種人很有問題8F 12/27 14:12
→ : 覺得自己寫得不好而寫一堆註解 這種人也很有問題
→ : 覺得自己寫得不好而寫一堆註解 這種人也很有問題
→ : 寫SAMPLE CODE一樣道理，曲高和寡，不是人人懂你的pattern10F 12/27 14:14
→ : 註解是寫給三個月後的自己看的11F 12/27 14:15
推 : 不過這樣討論都打高空啦 除非你貼一段被念的程式跟註12F 12/27 14:21
→ : 解
→ : 解
推 : 多練習爬code不看註解吧14F 12/27 14:22
推 : git log是很好用的東西，每個人都在程式碼內註解一段，15F 12/27 14:24
→ : 那到底是要看程式還是看註解
→ : 那到底是要看程式還是看註解
→ : 蘋果官方的code都有註解了 不寫註解超越蘋果17F 12/27 14:32
推 : 註解！=文件18F 12/27 14:35
→ : 我只有Unittest寫註解19F 12/27 14:38
推 : 我覺得至少在func/cls開頭簡單地寫一行這是拿來幹嘛20F 12/27 14:39
推 : 我是會在比較複雜的判斷上寫註解，以後看比較不用思考21F 12/27 14:39
→ : 可以節省讓後來閱讀的人節省很多時間及不必要的猜測22F 12/27 14:40
推 : 程式碼本身就是註解23F 12/27 14:47
推 : 要看情況阿 你是要出API 沒註解行麼？ XD24F 12/27 14:48
噓 : 洗文章嗎25F 12/27 14:49
→ : 內部產品程式 註解有必要再加吧 有些潛規則不講很麻煩26F 12/27 14:49
推 : 自以為寫很好不用寫註解的很多+1 通常就是...自以為27F 12/27 15:00
推 : 要拜託28F 12/27 15:04
推 : 拜託要+129F 12/27 15:19
→ : 命名到為還是需要註解 因為每個人邏輯不一樣
→ : 命名到為還是需要註解 因為每個人邏輯不一樣
→ : 「當程式碼與註解不符時，你相信什麼？」31F 12/27 15:20
→ : 「The ultimate comment for the code is the code itself
→ : 「註解是用來『彌補我們用程式碼表達意圖的失敗』」
→ : 「The ultimate comment for the code is the code itself
→ : 「註解是用來『彌補我們用程式碼表達意圖的失敗』」
→ : 推樓上加一，商業邏輯可以另外寫在文件上去交接34F 12/27 15:21
推 : 會寫註解的，寫出去的註解越多，回來問的越少35F 12/27 15:29
推 : 換上有意義的命名後 註解的份量就變少了36F 12/27 15:38
→ : 並不會少..37F 12/27 15:40
→ : 把code寫的爛的一b然後跟你說：「我有寫注解」看完38F 12/27 15:42
→ : 注解再看code發現注解根本在誤導（你根本沒有任何方
→ : 法保證注解的正確性跟易懂）這種人我也見過不少就是
→ : 了
→ : 注解再看code發現注解根本在誤導（你根本沒有任何方
→ : 法保證注解的正確性跟易懂）這種人我也見過不少就是
→ : 了
推 : 直接註解寫文件位置 要看邏輯自己去查文件42F 12/27 16:02
推 : 先養成"程式即是註解"的code style43F 12/27 16:05
推 : 特殊處理寫，其他不寫44F 12/27 16:15
推 : 比較複雜的邏輯才會寫45F 12/27 16:18
推 : 看情境xd 建dl模型註解一下shape 後面的人會很感謝你46F 12/27 16:44
→ : 當然要寫阿，寫個magic搞搞後人47F 12/27 17:06
推 : 要拜託 文件也要寫一下48F 12/27 17:07
→ : 不然看到A05_001.java 這樣的沒註解沒文件鬼才知道
→ : 是要做啥的
→ : 不然看到A05_001.java 這樣的沒註解沒文件鬼才知道
→ : 是要做啥的
推 : 至少函式要寫註解說明功能 和input/output吧51F 12/27 17:17
推 : 我的註解通常只寫什麼時間 為何而改(bug 資安 需求單)52F 12/27 17:19
→ : 還有每個function上方註明用途
→ : 還有每個function上方註明用途
推 : 個人覺得都可以 不管寫不寫註解 只要你的code讓人不好54F 12/27 17:24
→ : 懂 那就有改進的空間 不管是加註解或是重構
→ : 懂 那就有改進的空間 不管是加註解或是重構
推 : 寫了註解 結果之後程式有改結果註解沒跟著改56F 12/27 18:03
--
※ 看板: terievv 文章推薦值: 0 目前人氣: 0 累積人氣: 532
回列表(←)
分享