作者mickeyboy (mickey)
看板Soft_Job
标题[请益] 没注解的专案该如何维护
时间Wed Jul 19 21:16:32 2017
爬了一下版规，如果有触犯到，再删文 谢谢
帮朋友代PO
最近接手公司的新专案，结果发现该专案
几乎完全没注解，可能一个档案里面
注解不超过10个字，也没手册
虽然变数名称那些都是用"有意义的英文"命名
大致上能猜得出"可能是跟什麽有关"
例如薪资单可能是A档案，但A档案中又一堆function
目前只能从MVC开始慢慢追，想请问版上的前辈们
如果遇到这种专案维护，有什麽技巧可以快速入手的
问公司的前辈，意思是摸索久了，自然就会记得了
感谢
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 36.234.194.96
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1500470195.A.D26.html
1F：推 RunRun5566: 需要的时候再改，不需要勉强自己全部吸收 07/19 21:26
2F：推 wlul: 个人认为写code最好能做到"程式本身即注解" 07/19 21:28
3F：→ wlul: 除非某处需要注解当时的spec或不合常规的需求，我才会注解 07/19 21:29
4F：→ wlul: 几年下来，年轻一辈的还是认为我的程式读起来没什麽问题 07/19 21:29
5F：→ wlul: 一点点分享:) 07/19 21:30
6F：推 abc0922001: 从资料流去看吧，按下什麽button，会到哪个function 07/19 21:43
7F：→ abc0922001: 摸透了写成文件偷偷藏着（X 07/19 21:44
8F：嘘 final01: 程式码不就是最好的注解了... 07/19 21:49
9F：推 sunnyvisit: 资料流+1 从入口到终点整个看过至少知道流程 07/19 21:49
10F：推 ripple0129: Clean code的概念啊，不过怕是Clean code的不注解概 07/19 21:50
11F：→ ripple0129: 念下写的Code却不Clean 07/19 21:50
12F：推 panda04056: 一堆人以为自己code很好读 然後说不用注解= = 07/19 21:54
13F：→ panda04056: 写的清楚加好的注解就是事半功倍啊 07/19 21:54
14F：→ panda04056: 不然每个人认为的好读根本天差地远 07/19 21:55
15F：推 t64141: 我是先找入口点，然後找尾端(存取资料库)，接着看中间有没 07/19 22:02
16F：→ t64141: 有粗略归纳出几层 07/19 22:02
17F：→ t64141: 如果有稍微分层或是分模组，那大概的雏型就有了，接着再慢 07/19 22:03
18F：→ t64141: 慢根据功能点去追细节 07/19 22:03
19F：推 lilicoco520: 从主要button点下去开始追资料流了... 07/19 22:05
20F：推 jj0321: X! 程式码就是最好的注解无误 听前人说明还不如我自己看 07/19 22:24
21F：→ jj0321: 然後还从无注解的旧架构翻成新架构 练功MAX 07/19 22:26
22F：推 fgh81113: 有没有看过注解错的程式 这样我倒不如不要注解 07/19 22:44
23F：→ testPtt: 如果是C#有做summary维护效率差很多 07/19 22:48
24F：推 Ekmund: 你要的是一整个架构的spec吧? 我发现其实这种东西不多 07/19 22:49
25F：→ Ekmund: 而且因为长年修修改改 也未必准确... 07/19 22:49
26F：→ Ekmund: 从流程下去追 问前辈"为什麽这样处理" 反而比较快 07/19 22:50
27F：→ james732: 半调子而且还跟code不同步的注解才是恐怖 07/19 22:53
28F：嘘 blitzran: 程式码要当注解，也要参数跟方法有好好写啊 07/19 22:59
29F：→ blitzran: 曾经遇过接手的老专案，class叫a01跟b01这样的 07/19 23:00
30F：推 lovebridget: 先问用途 从上往下看快太多 07/19 23:12
31F：→ viper9709: 这个只能认命追了 07/19 23:17
32F：→ dreamnook: 逻辑流 07/19 23:51
33F：→ t78973677: 有用框架会比较好追，像react、mvp，没有就要看他命名 07/20 07:54
34F：→ t78973677: 了 07/20 07:54
35F：嘘 kai5566: 二楼根本答非所问....只想说自己的事情 07/20 09:14
36F：→ htury: 靠ide去追code了 07/20 11:45
37F：推 Argos: 少在那边 99%的程式都烂到无法自我表达好呗 乖乖写你的注解 07/20 12:44
38F：→ lucky4283: 写注解不是很基本的概念吗?为什麽一堆人不写 07/20 14:30
39F：→ vi000246: clean code的概念是有些人写了注解就懒得重构 07/20 16:03
40F：→ vi000246: 重构+适度的注解才比较好读懂 07/20 16:03
41F：→ Argos: 事实是 拿我写clean code藉口说看程式就好不用写注解 注解 07/20 16:05
42F：→ Argos: 只会过时的 通常code一点也不clean 07/20 16:05
43F：→ Argos: 连注解都不肯好好维护 哪有心写clean code？ 07/20 16:06
44F：→ Argos: 而且clean code也没全反对注解 该解释的就好好解释清楚齁 07/20 16:07
45F：→ bobju: 看个案吧~ 不过目前能run得好好的东西就尽量别去动 07/20 16:08
46F：推 kaltu: 没注解好过注解骗你 07/20 18:16
47F：推 james732: 注解骗人的真的很惨 07/20 18:31
48F：推 kinanson: 有意义的命名跟注解没啥两样，如果你不懂为何要这样做， 07/20 19:34
49F：→ kinanson: 一样都看不懂 07/20 19:34
50F：推 xvid: 多半都是自以为易读实际是烂code 07/20 22:43
51F：→ xvid: 那种懒、随便的心态写出来的东西 最後都很多藉口 07/20 22:45
52F：推 nova06091: 因为有些人觉得写注解很low 07/21 08:05
53F：推 giacch: 你不知道以後程式都给AI写吗? 07/21 09:45
54F：→ giacch: 注解只是用来帮助记忆或给不懂的人看的 07/21 09:45
55F：推 f124: 易读? 哪考虑那麽多 案子先处理掉 接下来就是下个人的问题了 07/21 09:46
56F：→ Argos: 所以说懒就承认 把「会被注解骗」拿来当藉口的 写不出什麽 07/21 10:14
57F：→ Argos: clean code的啦 卖闹阿 07/21 10:14
58F：→ airtsubasa: 当一支报表数十个栏位，我宁愿用数字排列加上对应清单 07/21 15:14
59F：→ airtsubasa: 还比较好 07/21 15:14
60F：推 prag222: 啥逻辑刘?没看过有人写个FUNCTION全部挤一起3000行? 07/21 21:37
61F：推 rice9547: 公司前辈的code都没注解，但我一目了然 07/21 22:31
62F：推 e2755699: 原来不写注解是因为懒0.0 07/22 10:05
63F：推 vaper: 在职时满注解，离职後clean code。这样有了解吗~~呵 07/22 18:34
感谢热心的建议，朋友是说因为是不同团队
所以风格上有些差异，原团队虽然命名比较不严谨
不过因为都有文件跟架构说明，function也有注解说明
所以才求救看有什麽经验处理，感谢~
※ 编辑: mickeyboy (36.234.192.141), 07/23/2017 21:08:06
64F：推 f124: 先搞懂那系统是干麻用的 怎麽用 再来追吧 07/23 22:10