作者superpai (超级白)
看板Soft_Job
标题Re: [讨论] 要不要写注解
时间Sun Oct 27 06:39:41 2019
整理一下讨论中主张要写注解的理由，有些比较不必要
1. 程式的why 「写个一行10~20个字这个method干麻」
这个可以写在test spec中。特别是BDD的testing lib的desribe还可以套很多层
应该够你写了
2. 责任分配 「// 此功能因某某某要求故加上」
这个应该是写在commit message，或是commit message上打issue系统的id
从issue可以看到开票的人和理由
3. 商业逻辑 「IFRS制度变换」
提出这个理由的人真的会在注解写那麽多吗？
要实作什麽需要应该是PM会写user story，在commit message给连结就好了
我不会说要不要写注解是对的还是错的
每个人环境不同，就必须有不同的行动来对应
不过我的环境会让我觉得要写注解是个例外或是最後手段
如果你很需要写上面三种注解
我会建议你考虑找新工作，你值得更好。
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 120.88.154.164 (澳大利亚)
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1572129583.A.FB6.html
1F：→ KeyFSN: 我觉得你还是不要太自信... 10/27 08:30
2F：推 yamakazi: 我猜的啦 很多版友的公司其实没有用issue tracker 10/27 09:09
3F：推 yamakazi: 不然怎麽会有人想把2 3 写进程式码注解 10/27 09:11
4F：推 abccbaandy: 很多issue tracker是给上面看的，实际需求又是另一回 10/27 11:12
5F：→ abccbaandy: 事 10/27 11:12
6F：推 dalconan: 2还有种状况是开发新功能时发现和旧功能有冲突的特例 10/27 11:57
7F：→ dalconan: 这时候的commit msg可能会是在说明新功能，除非硬拆一个 10/27 11:57
8F：→ dalconan: 写这个区块的特例commit 10/27 11:58
9F：推 onlyeric23: 虽然是老议题却仍是能看到滥用注解的案例 10/27 12:59
10F：推 GGFACE: 我觉得你还是不要太自信... 10/27 13:48
11F：推 anandydy529: 有些公司都用资料夹版控，你还要求开issue 10/27 14:48
12F：→ keke0421: 你连程式码上面的注解都懒得写 我就不信你会写在jira 10/27 15:38
13F：→ keke0421: or test spec 10/27 15:38
14F：→ superpai: 不要太自信是什麽梗？ 10/27 16:02
15F：→ t64141: 重点是最後一段阿 10/27 16:20
16F：嘘 alihue: 多的是，逻辑很简单，但不知道为何要这麽做，你又不敢拔的 10/27 18:23
17F：→ Lomonosov: 有点好奇你test spec是写的多好懂会比一段文字还好懂 10/27 20:44
18F：→ superpai: test spec 不就是一段文字吗？ 10/27 20:46
19F：→ Lomonosov: 喔抱歉搞错了 我以为是test的code 10/27 20:47
20F：→ viper9709: 推一楼 10/27 23:13
21F：→ leolarrel: 我觉得一楼还是不要太自信... 10/28 13:09
22F：推 senjor: 大多时候的确都不需要写注解，就好像大多时候都不需要加班 10/28 14:48
23F：→ senjor: 然而大多数人还是会加班 XDDD 10/28 14:48
24F：推 Ghamu: 没用过 BDD test lib 但如果还要另外翻看的话还是写注解比 10/28 20:19
25F：→ Ghamu: 较好？ 10/28 20:19