回看板
Disp BBS
看板
Soft_Job
作者
sec5566
(sec)
標題
[請益] 寫註解到底是不是好習慣
時間
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
sec5566
Re: [請益] 寫註解到底是不是好習慣
12-27 17:38
hidog
Re: [請益] 寫註解到底是不是好習慣
12-29 04:36
Ghamu
※ 編輯: sec5566 (223.140.72.67), 12/27/2018 13:48:43
推
t64141
: 想不寫註解有很多前提,而這個前提不容易達到
1F 12/27 13:54
推
oneheat
: 好的代碼很少在寫註解,或者說,code都寫不好了,為什麼
會覺得註解會寫的好呢?
2F 12/27 13:55
→
BeardSmallGG
: 有寫註解讓其他人比較省時吧 五六行的程式 一句註解
就知道在幹嘛了 有時候哪有時間在那邊一行一行看
4F 12/27 14:02
推
steve1012
: 需要很多註解常常不是件好事
6F 12/27 14:07
推
deray
: 寫什麼註解?貼一段來看一下為什麼需要註解
7F 12/27 14:11
推
yyc1217
: 覺得自己寫的很好就不寫註解 這種人很有問題
覺得自己寫得不好而寫一堆註解 這種人也很有問題
8F 12/27 14:12
→
iiiii
: 寫SAMPLE CODE一樣道理,曲高和寡,不是人人懂你的pattern
10F 12/27 14:14
→
yyc1217
: 註解是寫給三個月後的自己看的
11F 12/27 14:15
推
steve1012
: 不過這樣討論都打高空啦 除非你貼一段被念的程式跟註
解
12F 12/27 14:21
推
stupid0319
: 多練習爬code不看註解吧
14F 12/27 14:22
推
kokacal
: git log是很好用的東西,每個人都在程式碼內註解一段,
那到底是要看程式還是看註解
15F 12/27 14:24
→
femlro
: 蘋果官方的code都有註解了 不寫註解超越蘋果
17F 12/27 14:32
推
deray
: 註解!=文件
18F 12/27 14:35
→
askaleroux
: 我只有Unittest寫註解
19F 12/27 14:38
推
thefattiger
: 我覺得至少在func/cls開頭簡單地寫一行這是拿來幹嘛
20F 12/27 14:39
推
jknm0510a
: 我是會在比較複雜的判斷上寫註解,以後看比較不用思考
21F 12/27 14:39
→
thefattiger
: 可以節省讓後來閱讀的人節省很多時間及不必要的猜測
22F 12/27 14:40
推
hotdogmc
: 程式碼本身就是註解
23F 12/27 14:47
推
Argos
: 要看情況阿 你是要出API 沒註解行麼? XD
24F 12/27 14:48
噓
abc0922001
: 洗文章嗎
25F 12/27 14:49
→
Argos
: 內部產品程式 註解有必要再加吧 有些潛規則不講很麻煩
26F 12/27 14:49
推
sean2449
: 自以為寫很好不用寫註解的很多+1 通常就是...自以為
27F 12/27 15:00
推
yesyesyesyes
: 要拜託
28F 12/27 15:04
推
KanzakiHAria
: 拜託要+1
命名到為還是需要註解 因為每個人邏輯不一樣
29F 12/27 15:19
→
deray
: 「當程式碼與註解不符時,你相信什麼?」
「The ultimate comment for the code is the code itself
「註解是用來『彌補我們用程式碼表達意圖的失敗』」
31F 12/27 15:20
→
knives
: 推樓上加一,商業邏輯可以另外寫在文件上去交接
34F 12/27 15:21
推
LoserWon
: 會寫註解的,寫出去的註解越多,回來問的越少
35F 12/27 15:29
推
ymcheung
: 換上有意義的命名後 註解的份量就變少了
36F 12/27 15:38
→
rofellosx
: 並不會少..
37F 12/27 15:40
→
dnabossking
: 把code寫的爛的一b然後跟你說:「我有寫注解」看完
注解再看code發現注解根本在誤導(你根本沒有任何方
法保證注解的正確性跟易懂)這種人我也見過不少就是
了
38F 12/27 15:42
推
vi000246
: 直接註解寫文件位置 要看邏輯自己去查文件
42F 12/27 16:02
推
exeex
: 先養成"程式即是註解"的code style
43F 12/27 16:05
推
iamshiao
: 特殊處理寫,其他不寫
44F 12/27 16:15
推
kevin28
: 比較複雜的邏輯才會寫
45F 12/27 16:18
推
sean50301
: 看情境xd 建dl模型註解一下shape 後面的人會很感謝你
46F 12/27 16:44
→
KanoLoa
: 當然要寫阿,寫個magic搞搞後人
47F 12/27 17:06
推
twilighthook
: 要拜託 文件也要寫一下
不然看到A05_001.java 這樣的沒註解沒文件鬼才知道
是要做啥的
48F 12/27 17:07
推
sachung28
: 至少函式要寫註解說明功能 和input/output吧
51F 12/27 17:17
推
ekin1983
: 我的註解通常只寫什麼時間 為何而改(bug 資安 需求單)
還有每個function上方註明用途
52F 12/27 17:19
推
channaiN2
: 個人覺得都可以 不管寫不寫註解 只要你的code讓人不好
懂 那就有改進的空間 不管是加註解或是重構
54F 12/27 17:24
推
PoloHuang
: 寫了註解 結果之後程式有改結果註解沒跟著改
56F 12/27 18:03
--
作者 sec5566 的最新發文:
+14
[問卦] 為什麼YT比電視節目還好看 - Gossiping 板
作者:
sec5566
123.194.0.110
(台灣)
2023-05-28 00:33:20
43F 14推
+20
[問卦] 窮人會恨自己的父母嗎 - Gossiping 板
作者:
sec5566
223.140.7.88
(台灣)
2021-06-04 21:09:24
大家都說窮人不要生, 免得小孩長大恨你, 各位窮人們有恨父母嗎? 有無這類八卦啊 Sent from JPTT on my LGE LM-K510.
75F 25推 5噓
+26
[討論] 游泳自學還是請教練好 - WomenTalk 板
作者:
sec5566
111.71.76.174
(台灣)
2021-06-03 09:51:22
等疫情後想學游泳, 我看別人都是自己玩就會游泳了, 然後我學的目的也只是當作保命技能而已, 沒有要多專精, 應該自學還是請教練? 另外旱鴨子需要準備什麼? 耳塞 頭套 浮板要嗎? Sent from …
83F 26推
+18
[問卦] 文組到底幾歲交第一任啊 - Gossiping 板
作者:
sec5566
36.224.91.68
(台灣)
2021-06-02 16:55:12
剛跟一個文組同事聊天, 他三十出頭而已, 他說他初戀算晚的,大一才交第一個, 他因為很愛打籃球, 參加系隊才認識到, 我就超傻眼的,大一十八歲已經算贏過多少人了, 我們理工科系一堆都大四還母胎的, 文 …
41F 22推 4噓
+26
[討論] 不會游泳的人多嗎? - WomenTalk 板
作者:
sec5566
36.224.91.68
(台灣)
2021-06-02 02:54:47
聽著貓咪的飲水機聲失眠, 想到自己三十幾歲了還不會游泳, 大學必修游泳,因為實在太怕水, 連加強班都學不會, 考試還是很遜的用走的, 最後老師只好用跑操場替代讓我過, 有人也是旱鴨子的嗎? Sent …
78F 26推
點此顯示更多發文記錄