整理一下讨论中主张要写注解的理由,有些比较不必要
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给连结就好了
我不会说要不要写注解是对的还是错的
每个人环境不同,就必须有不同的行动来对应
不过我的环境会让我觉得要写注解是个例外或是最后手段
如果你很需要写上面三种注解
我会建议你考虑找新工作,你值得更好。
作者:
KeyFSN ( ~☼☽✩☁~ )
2019-10-27 08:30:00我觉得你还是不要太自信...
作者:
yamakazi (大安吴彦祖)
2019-10-27 09:09:00我猜的啦 很多版友的公司其实没有用issue tracker不然怎么会有人想把2 3 写进程式码注解
很多issue tracker是给上面看的,实际需求又是另一回事
2还有种状况是开发新功能时发现和旧功能有冲突的特例这时候的commit msg可能会是在说明新功能,除非硬拆一个写这个区块的特例commit
作者: onlyeric23 (MiGG) 2019-10-27 12:59:00
虽然是老议题却仍是能看到滥用注解的案例
作者:
GGFACE (ggface)
2019-10-27 13:48:00我觉得你还是不要太自信...
你连程式码上面的注解都懒得写 我就不信你会写在jiraor test spec
作者: t64141 (榕树) 2019-10-27 16:20:00
重点是最后一段阿
作者:
alihue (wanda wanda)
2019-10-27 18:23:00多的是,逻辑很简单,但不知道为何要这么做,你又不敢拔的
有点好奇你test spec是写的多好懂会比一段文字还好懂
作者:
senjor (哞哞)
2019-10-28 14:48:00大多时候的确都不需要写注解,就好像大多时候都不需要加班然而大多数人还是会加班 XDDD
作者:
Ghamu (猫丸)
2019-10-28 20:19:00没用过 BDD test lib 但如果还要另外翻看的话还是写注解比较好?