作者sec5566 (sec)
看板Soft_Job
标题[讨论] 要不要写注解
时间Fri Oct 25 21:12:36 2019
听过说法是
1.写注解是浪费时间，命名命的好不需要写
2.写注解方便维护，而且读中文一定比读英文快
自己是常常忽略注解，
不过有空还是会补上，
因为程式都只有我在弄，
但是当大型系统过一阵子在拿出来改时，
就知道不写注解真的是省小时间花大时间，
像是一堆函式传几个变数能跑出什麽，
还是同样提资料，这2个提出来差在哪？
不写後面维护的人，就要很辛苦去看里面，
尤其是交接工作，
大家会写注解吗？
-----
Sent from JPTT on my Sony H4331.
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 223.136.158.205 (台湾)
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1572009158.A.286.html
1F：推 t64141: 写必要且有实质功能的注解 10/25 21:16
2F：→ kira1101: 可以爬文看看 之前有很多讨论注解的 10/25 21:20
3F：→ kira1101: 去年好像问同样问题的也是你 10/25 21:21
4F：推 CoNsTaR: 命名和注解互助的，可以两个都有，例如： 10/25 21:25
5F：→ CoNsTaR: // This member does not need to be most updated 10/25 21:25
6F：→ CoNsTaR: int ref_count; 10/25 21:25
7F：→ CoNsTaR: 就会比单纯靠命名还要好： 10/25 21:25
8F：→ CoNsTaR: int ref_count_cache; 10/25 21:25
9F：推 IHSAHN: 不写注解受害的只会是一年後的你 10/25 21:27
10F：推 CoNsTaR: 有些语言的 IDE 只要把滑鼠放在变数、函数、结构上面就可 10/25 21:29
11F：→ CoNsTaR: 以看到它的注解，这种保证比纯靠命名的好多了 10/25 21:29
12F：推 judge1226: 推一楼 10/25 21:31
13F：推 alihue: 认为命名好不需要写的，大概都只写小专案吧 10/25 21:51
14F：→ alihue: 大概没看过给你开 debug mode 还不知道在做什麽的 code 10/25 21:51
15F：推 sullivan1982: 我是不写注解派，只有在一些work around会写，希望 10/25 22:02
16F：→ sullivan1982: 将来可以修正 10/25 22:02
17F：→ joejoe14758: 写啊 有些商业逻辑你就算能用英文写出来 别人也不一 10/25 22:05
18F：→ joejoe14758: 定看的懂 有些工程师英文烂到炸 你还用英文写 10/25 22:05
19F：→ benedict76: 我们team规定要加英文annotation，用中文有时候build 10/25 22:10
20F：→ benedict76: code会有问题! 10/25 22:10
21F：→ spfy: 当你会问这问题就是要写 为了你好也为了後人好 10/25 22:17
22F：→ zo6596001: 上份工作看到String莫名其妙变成Function的神奇写法 10/25 22:23
23F：→ zo6596001: 这种特殊用法没有写注解後面维护的人很痛苦。 10/25 22:24
24F：推 bill0205: 只有各种function的注解 里面除非是核心逻辑 不然不写 10/25 22:27
25F：推 legion87: 如果是strong type的程式语言，命名原则和词汇有定义好 10/25 22:28
26F：→ legion87: 搭配固定的design pattern，确实可以不太需要注解 10/25 22:28
27F：→ legion87: 不过在现实生活中我还没看过这种专案 10/25 22:29
28F：推 ko27tye: 核心功能会吧 get或set那种靠命名就可以很直观了 10/25 22:35
29F：推 xrururururu: 写注解是为了自己 傻傻的 10/25 22:40
30F：→ MOONY135: 有时候注解会给予多余的扰乱 10/25 22:45
31F：→ loadingN: TODO FIXME 10/25 22:45
32F：推 hankyan919: 先定义什麽叫命名好 10/25 23:13
33F：→ viper9709: 推二楼 10/25 23:29
34F：推 somefatguy: 档 不能没有注解 10/25 23:33
35F：推 v7q4: 注解能拯救3个月後的我…… 10/25 23:43
36F：推 Bencrie: 我可以想像 2 的人讲话卷舌的样子 XD 10/25 23:44
37F：推 king22649: 看你想做多久(O 10/25 23:47
38F：→ flowheart: 这问题本身就是个陷阱，注解不是0或1的选择 10/25 23:50
39F：推 CloudyWing: 不会写注解说我这段在做什麽，但会写说我为什麽会这 10/25 23:50
40F：推 chuegou: 不写只是找自己麻烦而已 10/25 23:53
41F：→ testPtt: 通常不是英文的问题 而是可以避免深入追程式码 10/25 23:56
42F：→ william81615: 不写注解=拉屎给别人吞还不擦屁股 我是这麽觉得 10/25 23:56
43F：推 umum29: 写了的帮助绝对比你想像的多 10/26 00:01
44F：→ gpctv: 抱歉，我会写，因为以前的公司class function都要写注解， 10/26 00:34
45F：→ gpctv: 不写无法上版，接着我就习惯了 10/26 00:34
46F：嘘 bill0129bill: 要 10/26 00:55
47F：推 vi000246: 我都注解在自己的笔记本里 科科 10/26 01:08
48F：推 hooll111: 注解写清楚 不要废话 也不要大量注解程式码 用版控取代 10/26 02:09
49F：→ Cavalier: 当然要写, 命名命的再好也只能告诉你 how, 而不是 why 10/26 02:23
50F：→ Cavalier: 注解的目的不是解释程式码做什麽, 而是为什麽选择这样做 10/26 02:24
51F：推 superpai: 我都写spec不写注解 10/26 03:29
52F：推 senjor: 写Unit test不要写注解 10/26 03:35
53F：嘘 darkMood: /注解 10/26 04:07
54F：嘘 deray: 搜寻 注解 讨论到烂了 10/26 06:56
55F：→ eva19452002: var名称和func名称命的好 然後内聚力强 不太需要注解 10/26 07:12
56F：推 PoloHuang: 我是不写注解 10/26 07:44
57F：推 jack0204: 一定写注解，因为所有人的能力不平均 10/26 08:15
58F：推 goodga: 人的记忆力有限... 10/26 08:45
59F：推 NTULioner: 完美的情况不需要 但完美的情况不存在 10/26 08:55
60F：推 sxy67230: 看情况写，如果不是必要的就不写，我很多都只在function 10/26 09:20
61F：→ sxy67230: 或是class下面简略写这个class是干嘛的，这个function 10/26 09:20
62F：→ sxy67230: 是干嘛的，输入是甚麽输出是甚麽 10/26 09:20
63F：→ starburs: Clean Code 这本书里面注解都能自成一章了 10/26 10:00
64F：→ starburs: 要不要写注解不是简单几句话可以决定的 10/26 10:01
66F：→ qpowjohn: 至少会写function，内容再怎麽走钟至少方向不变，如果 10/26 11:29
67F：→ qpowjohn: 方向变了那怎麽不另外写一只function 10/26 11:29
68F：推 Vick753: 你就想注解写得好是一门学问 10/26 11:33
69F：→ lucifiel0121: 写注解是为了交流，沟通「意图」。如果是 i++ 注解 10/26 12:10
70F：→ lucifiel0121: 写 i 会加1 ，这种不用写，要写「为什麽是加1」 10/26 12:10
71F：推 jason710068: Clean code有教,去多看两遍 10/26 12:12
72F：推 shter: 演算法的 function 开头写个数学公式注解也还好吧 10/26 12:15
73F：推 thsyou9527: 我会写 方便过很久後回头看 10/26 12:53
74F：→ eva19452002: 光一个变数命名就可以写成一本书 10/26 13:56
75F：推 zased: 注解弥补命名无法顾到的地方 为什麽这里要做这个 因为什麽 10/26 14:48
76F：→ zased: 限制 10/26 14:48
77F：推 eatpupu: 必要才写，失修的注解比不写还可怕 10/26 15:21
78F：推 clamperni: 感觉来了就写啊 10/26 20:48
79F：推 ji2my: 程式写到让人一眼就看懂就不用写拉 10/26 22:16
80F：推 thbw666: 有注解是写中文的喔? 10/26 22:36
81F：推 labdog: 以前工作有看过每一行code都会写中文注解的leader 10/27 00:22
82F：→ realbout: 一开始会写 後来不写 後来写一点XD 10/27 00:38
83F：嘘 KanzakiHAria: 要问几次 10/27 14:43
84F：嘘 bonfferoni: 我的注解用中文写好拿去google翻成阿拉伯文 给你参考 10/27 22:53
85F：嘘 anlick: 你之前在本板发问问过类似的问题 洗文章? 10/28 03:13
86F：嘘 shooter555: 原来是洗文 10/28 09:30
87F：嘘 abc0922001: 他就单纯想洗文 10/28 09:37
88F：嘘 asoro: 要 10/28 13:21
89F：嘘 DCTmaybe: 他只要被嘘太多就会自己把文章删掉 10/28 16:56
90F：→ sj1973: 特别复杂的地方要注解, 尤其封包内容. 10/29 16:24