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

看板Soft_Job作者 (sec)時間5年前 (2018/12/27 13:48), 5年前編輯推噓51(57推 6噓 78→)
留言141則, 77人參與, 5年前最新討論串1/24 (看更多)
以前上課跟書本都提到寫註解， 但是我看資深同事還有接手的程式碼， 都沒有註解，只有我在寫， 還被主管念過寫註解沒必要， 命名好就夠了， 是我觀念落伍了嗎？ ----- Sent from JPTT on my Sony H4331. -- ※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 223.140.72.67 ※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1545889713.A.2B5.html ※ 編輯: sec5566 (223.140.72.67), 12/27/2018 13:48:43
推
12/27 13:54, 5年前 , 1F
想不寫註解有很多前提，而這個前提不容易達到
12/27 13:54, 1F
推
12/27 13:55, 5年前 , 2F
好的代碼很少在寫註解，或者說，code都寫不好了，為什麼
12/27 13:55, 2F
→
12/27 13:55, 5年前 , 3F
會覺得註解會寫的好呢？
12/27 13:55, 3F
→
12/27 14:02, 5年前 , 4F
有寫註解讓其他人比較省時吧 五六行的程式 一句註解
12/27 14:02, 4F
→
12/27 14:02, 5年前 , 5F
就知道在幹嘛了 有時候哪有時間在那邊一行一行看
12/27 14:02, 5F
推
12/27 14:07, 5年前 , 6F
需要很多註解常常不是件好事
12/27 14:07, 6F
推
12/27 14:11, 5年前 , 7F
寫什麼註解？貼一段來看一下為什麼需要註解
12/27 14:11, 7F
推
12/27 14:12, 5年前 , 8F
覺得自己寫的很好就不寫註解 這種人很有問題
12/27 14:12, 8F
→
12/27 14:13, 5年前 , 9F
覺得自己寫得不好而寫一堆註解 這種人也很有問題
12/27 14:13, 9F
→
12/27 14:14, 5年前 , 10F
寫SAMPLE CODE一樣道理，曲高和寡，不是人人懂你的pattern
12/27 14:14, 10F
→
12/27 14:15, 5年前 , 11F
註解是寫給三個月後的自己看的
12/27 14:15, 11F
推
12/27 14:21, 5年前 , 12F
不過這樣討論都打高空啦 除非你貼一段被念的程式跟註
12/27 14:21, 12F
→
12/27 14:21, 5年前 , 13F
解
12/27 14:21, 13F
推
12/27 14:22, 5年前 , 14F
多練習爬code不看註解吧
12/27 14:22, 14F
推
12/27 14:24, 5年前 , 15F
git log是很好用的東西，每個人都在程式碼內註解一段，
12/27 14:24, 15F
→
12/27 14:24, 5年前 , 16F
那到底是要看程式還是看註解
12/27 14:24, 16F
→
12/27 14:32, 5年前 , 17F
蘋果官方的code都有註解了 不寫註解超越蘋果
12/27 14:32, 17F
推
12/27 14:35, 5年前 , 18F
註解！=文件
12/27 14:35, 18F
→
12/27 14:38, 5年前 , 19F
我只有Unittest寫註解
12/27 14:38, 19F
推
12/27 14:39, 5年前 , 20F
我覺得至少在func/cls開頭簡單地寫一行這是拿來幹嘛
12/27 14:39, 20F
推
12/27 14:39, 5年前 , 21F
我是會在比較複雜的判斷上寫註解，以後看比較不用思考
12/27 14:39, 21F
→
12/27 14:40, 5年前 , 22F
可以節省讓後來閱讀的人節省很多時間及不必要的猜測
12/27 14:40, 22F
推
12/27 14:47, 5年前 , 23F
程式碼本身就是註解
12/27 14:47, 23F
推
12/27 14:48, 5年前 , 24F
要看情況阿 你是要出API 沒註解行麼？ XD
12/27 14:48, 24F
噓
12/27 14:49, 5年前 , 25F
洗文章嗎
12/27 14:49, 25F
→
12/27 14:49, 5年前 , 26F
內部產品程式 註解有必要再加吧 有些潛規則不講很麻煩
12/27 14:49, 26F
推
12/27 15:00, 5年前 , 27F
自以為寫很好不用寫註解的很多+1 通常就是...自以為
12/27 15:00, 27F
推
12/27 15:04, 5年前 , 28F
要拜託
12/27 15:04, 28F
推
12/27 15:19, 5年前 , 29F
拜託要+1
12/27 15:19, 29F
→
12/27 15:19, 5年前 , 30F
命名到為還是需要註解 因為每個人邏輯不一樣
12/27 15:19, 30F
→
12/27 15:20, 5年前 , 31F
「當程式碼與註解不符時，你相信什麼？」
12/27 15:20, 31F
→
12/27 15:20, 5年前 , 32F
「The ultimate comment for the code is the code itself
12/27 15:20, 32F
→
12/27 15:21, 5年前 , 33F
「註解是用來『彌補我們用程式碼表達意圖的失敗』」
12/27 15:21, 33F
→
12/27 15:21, 5年前 , 34F
推樓上加一，商業邏輯可以另外寫在文件上去交接
12/27 15:21, 34F
推
12/27 15:29, 5年前 , 35F
會寫註解的，寫出去的註解越多，回來問的越少
12/27 15:29, 35F
推
12/27 15:38, 5年前 , 36F
換上有意義的命名後 註解的份量就變少了
12/27 15:38, 36F
→
12/27 15:40, 5年前 , 37F
並不會少..
12/27 15:40, 37F
→
12/27 15:42, 5年前 , 38F
把code寫的爛的一b然後跟你說：「我有寫注解」看完
12/27 15:42, 38F
→
12/27 15:42, 5年前 , 39F
注解再看code發現注解根本在誤導（你根本沒有任何方
12/27 15:42, 39F
還有 62 則推文
推
12/28 01:39, 5年前 , 102F
最好的程式碼為程式即是註解 去讀讀code complete就知道了
12/28 01:39, 102F
→
12/28 05:27, 5年前 , 103F
可讀性越低的語言越需要註解
12/28 05:27, 103F
→
12/28 05:27, 5年前 , 104F
ASM每個block註解很常見
12/28 05:27, 104F
→
12/28 05:27, 5年前 , 105F
Python本身就是可執行的虛擬碼，註解遠比doc string少見
12/28 05:27, 105F
推
12/28 06:41, 5年前 , 106F
通常只會在寫這個function拿來幹嘛 或是這個檔案的功能
12/28 06:41, 106F
→
12/28 09:24, 5年前 , 107F
跟可讀性沒甚麼關係..
12/28 09:24, 107F
→
12/28 09:28, 5年前 , 108F
程式即是註解?程式碼都看完了還需要看註解嗎
12/28 09:28, 108F
→
12/28 09:30, 5年前 , 109F
有時候你會看到很神奇的寫法在裡面，還會覺得邏輯很怪
12/28 09:30, 109F
→
12/28 09:31, 5年前 , 110F
這種不寫註解根本不知道它是修了什麼鬼東西才在裡面的
12/28 09:31, 110F
推
12/28 09:36, 5年前 , 111F
我是覺得在比較難懂的地方寫一兩行註解有好無壞
12/28 09:36, 111F
噓
12/28 09:45, 5年前 , 112F
會問這問題就是只會寫很廢的註解吧？
12/28 09:45, 112F
→
12/28 09:47, 5年前 , 113F
話說我有看過每一行function call都寫註解的
12/28 09:47, 113F
推
12/28 14:48, 5年前 , 114F
有規範的註解才是好註解 跟log、版本更新資訊一樣
12/28 14:48, 114F
→
12/28 18:22, 5年前 , 115F
如果一個專案做了五六年，你想都不註解會怎樣
12/28 18:22, 115F
推
12/28 18:50, 5年前 , 116F
要交接的就要寫吧 每個人邏輯又不一樣
12/28 18:50, 116F
推
12/28 18:51, 5年前 , 117F
還是需要，不需要就不會有這個功能給你寫了，重點會不會寫
12/28 18:51, 117F
→
12/28 21:56, 5年前 , 118F
有些hard code的東西不寫註解 誰知道那3小意思
12/28 21:56, 118F
→
12/28 21:57, 5年前 , 119F
註解就是個輔助工具 該用則用 不該用則不用
12/28 21:57, 119F
→
12/28 21:57, 5年前 , 120F
沒有好不好 而是有沒有用對地方
12/28 21:57, 120F
→
12/28 21:58, 5年前 , 121F
就跟if 一樣 看過七八層的if 看了只想翻臉
12/28 21:58, 121F
→
12/28 21:59, 5年前 , 122F
但也不能說用if不對 而是亂用用到沒水準
12/28 21:59, 122F
→
12/28 21:59, 5年前 , 123F
若真的需要用到七八層if也沒啥不對 但有些只要2層
12/28 21:59, 123F
→
12/29 01:35, 5年前 , 124F
一樓正解
12/29 01:35, 124F
噓
12/29 01:43, 5年前 , 125F
菜島會問/沒寫過大程式會問/沒集體開發過會問
12/29 01:43, 125F
推
12/29 17:13, 5年前 , 126F
註解當然是寫給3個月後的自己看R
12/29 17:13, 126F
推
12/29 19:12, 5年前 , 127F
不寫註解 你以為你看得懂5.6年前自己寫了三小嗎
12/29 19:12, 127F
推
12/29 19:26, 5年前 , 128F
可以貼你被念的那段註解長怎樣嗎
12/29 19:26, 128F
推
12/29 23:46, 5年前 , 129F
我一般就每個function說一下在幹嘛就好
12/29 23:46, 129F
→
12/29 23:46, 5年前 , 130F
寫的比較複雜的部份才會特別加
12/29 23:46, 130F
→
12/29 23:47, 5年前 , 131F
而且常常自己寫的過幾個月自己也看不懂
12/29 23:47, 131F
→
12/29 23:47, 5年前 , 132F
註解至少讓我找得到哪裡要改
12/29 23:47, 132F
→
12/30 21:13, 5年前 , 133F
取決於你東西寫的好不好 註解、文檔寫不好那乾脆不要
12/30 21:13, 133F
→
12/30 21:14, 5年前 , 134F
寫 程式碼寫不好乾脆不要寫...? 阿 不是 是打掉重練
12/30 21:14, 134F
→
12/30 21:21, 5年前 , 135F
喜歡寫大而全代碼風格的喜歡用註解來維持代碼可讀
12/30 21:21, 135F
→
12/30 21:22, 5年前 , 136F
喜歡用寫小而精風格代碼的喜歡用簡潔易懂風格來維持
12/30 21:22, 136F
→
12/30 21:22, 5年前 , 137F
代碼可讀性
12/30 21:22, 137F
推
12/31 03:18, 5年前 , 138F
當你需要在數分鐘內解bug，你會感激自己半年前的註解
12/31 03:18, 138F
→
12/31 03:18, 5年前 , 139F
解
12/31 03:18, 139F
噓
12/31 12:28, 5年前 , 140F
這總討戰文時不時就會出現
12/31 12:28, 140F
→
12/31 14:20, 5年前 , 141F
應該要是好的，但有些註解寫得跟實際不同，反而誤導
12/31 14:20, 141F
‣ 更多 sec5566 的文章
文章代碼(AID): #1S96UnAr (Soft_Job)
討論串 (同標題文章)
以下文章回應了本文 (最舊先)：
完整討論串 (本文為第 1 之 24 篇)：
排序： 最舊先 | 最新先 | 留言數
在新視窗開啟完整討論串 (共24篇)
‣ 更多 sec5566 的文章
文章代碼(AID): #1S96UnAr (Soft_Job)