[请益] 没注解的专案该如何维护

楼主: mickeyboy (mickey)   2017-07-19 21:16:32
爬了一下版规,如果有触犯到,再删文 谢谢
帮朋友代PO
最近接手公司的新专案,结果发现该专案
几乎完全没注解,可能一个档案里面
注解不超过10个字,也没手册
虽然变量名称那些都是用"有意义的英文"命名
大致上能猜得出"可能是跟什么有关"
例如薪资单可能是A档案,但A档案中又一堆function
目前只能从MVC开始慢慢追,想请问版上的前辈们
如果遇到这种专案维护,有什么技巧可以快速入手的
问公司的前辈,意思是摸索久了,自然就会记得了
感谢
作者: RunRun5566 (跑跑五六)   2017-07-19 21:26:00
需要的时候再改,不需要勉强自己全部吸收
作者: wlul   2017-07-19 21:28:00
个人认为写code最好能做到"程式本身即注解"除非某处需要注解当时的spec或不合常规的需求,我才会注解几年下来,年轻一辈的还是认为我的程式读起来没什么问题一点点分享:)
作者: abc0922001 (中士abc)   2017-07-19 21:43:00
从资料流去看吧,按下什么button,会到哪个function摸透了写成文件偷偷藏着(X
作者: final01 (牛顿运动定律)   2017-07-19 21:49:00
程式码不就是最好的注解了...
作者: sunnyvisit (visit)   2017-07-19 21:49:00
资料流+1 从入口到终点整个看过至少知道流程
作者: ripple0129 (perry tsai)   2017-07-19 21:50:00
Clean code的概念啊,不过怕是Clean code的不注解概念下写的Code却不Clean
作者: panda04056 (圆仔cross56)   2017-07-19 21:54:00
一堆人以为自己code很好读 然后说不用注解= =写的清楚加好的注解就是事半功倍啊不然每个人认为的好读根本天差地远
作者: t64141 (榕树)   2017-07-19 22:02:00
我是先找入口点,然后找尾端(存取数据库),接着看中间有没有粗略归纳出几层如果有稍微分层或是分模组,那大概的雏型就有了,接着再慢慢根据功能点去追细节
作者: lilicoco520 (哩哩)   2017-07-19 22:05:00
从主要button点下去开始追资料流了...
作者: jj0321 (JJ与你倒数唷)   2017-07-19 22:24:00
X! 程式码就是最好的注解无误 听前人说明还不如我自己看然后还从无注解的旧架构翻成新架构 练功MAX
作者: fgh81113 (阿景)   2017-07-19 22:44:00
有没有看过注解错的程式 这样我倒不如不要注解
作者: testPtt (测试)   2017-07-19 22:48:00
如果是C#有做summary维护效率差很多
作者: Ekmund (是一只小叔)   2017-07-19 22:49:00
你要的是一整个架构的spec吧? 我发现其实这种东西不多而且因为长年修修改改 也未必准确...从流程下去追 问前辈"为什么这样处理" 反而比较快
作者: james732 (好人超)   2017-07-19 22:53:00
半调子而且还跟code不同步的注解才是恐怖
作者: blitzran (heromater)   2017-07-19 22:59:00
程式码要当注解,也要参数跟方法有好好写啊曾经遇过接手的老专案,class叫a01跟b01这样的
作者: lovebridget (= =")   2017-07-19 23:12:00
先问用途 从上往下看快太多
作者: viper9709 (阿达)   2017-07-19 23:17:00
这个只能认命追了
作者: dreamnook (亚龙)   2017-07-19 23:51:00
逻辑流
作者: t78973677 (iis)   2017-07-20 07:54:00
有用框架会比较好追,像react、mvp,没有就要看他命名了
作者: kai5566 (改名Dirk_AI56)   2017-07-20 09:14:00
二楼根本答非所问....只想说自己的事情
作者: htury (冰点)   2017-07-20 11:45:00
靠ide去追code了
作者: Argos (Big doge is watching u)   2017-07-20 12:44:00
少在那边 99%的程式都烂到无法自我表达好呗 乖乖写你的注解
作者: lucky4283 (KENNY)   2017-07-20 14:30:00
写注解不是很基本的概念吗?为什么一堆人不写
作者: vi000246 (Vi)   2017-07-20 16:03:00
clean code的概念是有些人写了注解就懒得重构重构+适度的注解才比较好读懂
作者: Argos (Big doge is watching u)   2017-07-20 16:05:00
事实是 拿我写clean code借口说看程式就好不用写注解 注解只会过时的 通常code一点也不clean连注解都不肯好好维护 哪有心写clean code?而且clean code也没全反对注解 该解释的就好好解释清楚齁
作者: bobju (枯藤老树昏鸦)   2017-07-20 16:08:00
看个案吧~ 不过目前能run得好好的东西就尽量别去动
作者: kaltu (ka)   2017-07-20 18:16:00
没注解好过注解骗你
作者: james732 (好人超)   2017-07-20 18:31:00
注解骗人的真的很惨
作者: kinanson (kinanson)   2017-07-20 19:34:00
有意义的命名跟注解没啥两样,如果你不懂为何要这样做,一样都看不懂
作者: xvid (DivX)   2017-07-20 22:43:00
多半都是自以为易读实际是烂code那种懒、随便的心态写出来的东西 最后都很多借口
作者: nova06091   2017-07-21 08:05:00
因为有些人觉得写注解很low
作者: giacch   2017-07-21 09:45:00
你不知道以后程式都给AI写吗?注解只是用来帮助记忆或给不懂的人看的
作者: f124 (....)   2017-07-21 09:46:00
易读? 哪考虑那么多 案子先处理掉 接下来就是下个人的问题了
作者: Argos (Big doge is watching u)   2017-07-21 10:14:00
所以说懒就承认 把“会被注解骗”拿来当借口的 写不出什么clean code的啦 卖闹阿
作者: airtsubasa (伪学姊)   2017-07-21 15:14:00
当一支报表数十个字段,我宁愿用数字排列加上对应清单还比较好
作者: prag222 (prag)   2017-07-21 21:37:00
啥逻辑刘?没看过有人写个FUNCTION全部挤一起3000行?
作者: rice9547 (一碗饭)   2017-07-21 22:31:00
公司前辈的code都没注解,但我一目了然
作者: e2755699 (酣酣)   2017-07-22 10:05:00
原来不写注解是因为懒0.0
作者: vaper (风雨飘摇的世代)   2017-07-22 18:34:00
在职时满注解,离职后clean code。这样有了解吗~~呵
作者: f124 (....)   2017-07-23 22:10:00
先搞懂那系统是干麻用的 怎么用 再来追吧

Links booklink

Contact Us: admin [ a t ] ucptt.com