作者YAYA6655 (YAYA)
看板Soft_Job
標題Re: [請益] 寫註解到底是不是好習慣
時間Sat Dec 29 14:20:40 2018
這個問題很廢話也很刻意
說不用寫註解的也很刻意要顯示自己很會寫碼
講句難聽點的，如果程式可以不用註解，那你從小到大念的國語課本最好也都不用
有註解好了，連生字都不用。
一堆人真的是為了顯示自己很行，換了年紀就換了腦袋。
有種不寫註解，那你小孩的國語課本請他們保留本文就好，其餘的都刪掉。
看他會考幾分。
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 111.83.7.83
※ 文章網址: https://webptt.com/m.aspx?n=bbs/Soft_Job/M.1546064443.A.BED.html
1F：→ pttworld: 程式語言關鍵字有限，國文課本生字量可以無限 12/29 14:57
2F：推 p122607: 課本的單字量哪來的無限 12/29 15:19
3F：推 errorsyntax: 這比喻滿酷的 12/29 15:28
4F：→ qpowjohn: 其實這比喻看起來蠻正確的？ 12/29 15:30
5F：→ qpowjohn: 註解是放在沒辦法一眼就看懂的地方 12/29 15:31
6F：推 itoni: 拿自然語言和程式語言比 不倫不類 12/29 15:38
7F：→ yyc1217: 然後他們會叫你去看clean code 卻不思考是否適用所有狀況 12/29 16:07
8F：推 alihue: 那些推崇不用註解的，都是在寫很簡單的東西吧 12/29 16:24
9F：推 molopo: 神比喻 12/29 17:57
10F：→ Ghamu: clean code沒說不寫註解啊～ 只是不要寫會過時的註解 重複 12/29 18:08
11F：→ Ghamu: 講一樣的事情等等 12/29 18:08
12F：→ Ghamu: 話說你提到有人自以為強不寫註解 實際上是有很多自以為弱的 12/29 18:14
13F：→ Ghamu: 人寫一堆註解 結果不把寫註解的時間拿去重構用好一點的命名 12/29 18:14
14F：→ Ghamu: 結果永遠不會成長 註解寫得再好 都不會提升 但好的命名 12/29 18:14
15F：→ Ghamu: 好的拆分那是跟你一輩子的 也不會因為需求變更還要去另外維 12/29 18:14
16F：→ Ghamu: 護 12/29 18:14
17F：推 gino0717: 我都把變數寫得跟註解一樣長 12/29 18:17
18F：推 Ghamu: 哈哈 不過其實這種討論有點張飛打岳飛 大家心裡定義的註解 12/29 18:19
19F：→ Ghamu: 應該都不一樣 但我個人是認為 [消除重複]應該是核心思維 當 12/29 18:19
20F：→ Ghamu: 註解沒辦法提供程式碼本身以外的資訊 意圖 那他就不該作為 12/29 18:19
21F：→ Ghamu: 程式碼本身的副本出現 12/29 18:19
22F：推 oneheat: 這種沒正解的問題永遠都可以吸引一堆人來發表意見 XD 12/29 18:20
23F：→ Ghamu: 以前我曾經幹過命名比註解長的蠢事XDD 後來我發現是因為我 12/29 18:22
24F：→ Ghamu: 忽略本來class的資訊 重複提及了 才會越串越長 12/29 18:22
25F：推 oneheat: G社通常會把註解放在header檔，或者是export的地方 12/29 18:25
26F：→ Ghamu: 其實正解早就有了～ 就在書本裡 但是有很多沒看過的資深人 12/29 18:26
27F：→ Ghamu: 士還拿古代人他習慣那一套做事 有點像現在還有人以為SVN G 12/29 18:26
28F：→ Ghamu: it 12/29 18:26
29F：→ Ghamu: 或者不用版本管控 這三個選項 只是工具不重要 最重要是事情 12/29 18:26
30F：→ Ghamu: 做完一樣 12/29 18:27
31F：→ Ghamu: 科技 理工界 九成新的東西出來 都是因為要改善舊的缺點 當 12/29 18:30
32F：→ Ghamu: 你聽到一個跟以前差很多的事情 先不及著否定 說不定他們才 12/29 18:30
33F：→ Ghamu: 是隊的 12/29 18:30
34F：推 oneheat: 你說的書本也是一種信仰啊，不同人的信仰不一定一樣 12/29 18:30
35F：→ Ghamu: 不太同意那是信仰 新的就是比舊的方式優秀 類似Git是要解決 12/29 18:41
36F：→ Ghamu: SVN不能決定何時solve conflict 提升平行開放效率 少寫註解 12/29 18:41
37F：→ Ghamu: 是因為它會過時 註解掉的程式碼沒人敢用 ....等 都有正解 12/29 18:41
38F：→ Ghamu: 了 但可能很多人沒更新到 12/29 18:41
39F：推 quickey: 不寫註解他多厲害我是都不信啦 12/29 20:08
40F：推 shooter555: 蠻貼切的形容 12/29 20:26
41F：推 peanut97: 這個比喻很棒！本質一樣！ 12/29 21:30
42F：推 abcf: 不寫註解，還講一堆clean code這種大道理的話，真是太好笑。 12/29 21:35
43F：→ t64141: clean code的作者沒有完全反對註解，裡面針對好的註解跟 12/29 21:59
44F：→ t64141: 不當的註解也分了兩篇來說，且註解是有沒有適當使用，不是 12/29 21:59
45F：→ t64141: 要不要使用的問題 12/29 21:59
46F：推 flysonics: 幾千行code不寫註解 嗯嗯 你會被接你code的人詛咒到死 12/29 23:08
47F：→ flysonics: 吧 12/29 23:08
48F：推 babelism: 從我剛出社會一開始接的案子就是萬行起跳,沒註解你試試 12/29 23:55
49F：推 sa074463: 這篇比喻得很好阿。從來就不相信程式碼就是註解 12/30 00:07
50F：→ clamperni: 要看註解寫得怎樣吧 整串討論就二分法寫跟不寫 12/30 00:27
51F：→ oneheat: 這種討論就這樣啊，一個不可能0也不可能1的問題被丟出來 12/30 00:53
52F：→ oneheat: ，就會有一堆0或1的預設立場去抒發自己的意見 12/30 00:53
53F：噓 steve1012: 到底誰說要完全不寫啦 12/30 02:53
54F：推 thethirdfoot: 適當的註解可以更快進入狀況 12/30 16:19
55F：推 twntwn: 自以為弱有什麼問題 謙虛總比自大好 12/31 14:15
56F：推 kira1101: 自以為弱的人常寫沒啥用的註解 用註解掩飾自己的爛扣 12/31 16:08