对接手项目的吐槽

尝试完成分配给我的一个需求,度过了糟糕的一天。了解了需求的逻辑,再对应到代码中去看,需求中只要添加一个地方,但小小的改动牵扯了一大片的逻辑。
当开始接需求时候,我的吐槽也开始了。

需求文档很重要

不熟悉每个字段的含义,对待许多个条件的判断便无从下手。
以往接手的项目后端都会提供接口文档,标明字段的含义和包含的值。
看这这份文档,再结合对应代码逻辑的判断,便很快的进入熟悉的状态,一个需求过后一部分功能就都很熟悉了。
但到了这里工作,文档竟然不完善,也没有人能完全把字段都说清楚,这就对阅读逻辑增加了不少的难度,看了一天下来也是一脸懵逼。
他们之前在做项目时,加一个简单的功能,只是返回一个字段而已,靠口口相传字段的含义完成需求,懒得花时间去写一个字段的含义到文档中,因为太简单,脑瓜子记得很清楚,便选择忽略记在文档的必要性。
经过长年累月的迭代,字段越来越多,新的记得清楚,旧的早已淡忘,由于忽视了记录,便忘记了很久之前的字段含义。更要命的是人员在流动,写字段的人走了,接手的人成了接盘的侠,可以想象接盘侠是何等的抓耳挠腮却无计可施,
望着一行行代码,陷入了深深的烦恼中。
所以在做项目中,写文档至关重要。没有文档的记录,看代码,只能抓瞎。

加注释有指导意义

项目代码经过几个人的手,迭代了多个需求,代码的可读性已经变得非常的差。
一个文件总共有4千行代码,查看一个判断,要从开始的200行,拉到中间的2000行,还要反复的拉上落下来确定逻辑的正确性,这简直就是浪费时间。
一个判断能超出一屏之外,还有很长,左右滑动记住来字段的名字,简直就是反人类。就不能折行显示,一眼扫下来全部在视线内,不至于手滑的疼痛。
洋洋洒洒写了很多行代码,竟然没有一句注释,这留给后来人简直就是噩梦,要一行一行的读,多个判断交织在一起,压根都不知道是做什么用的。顺手加行注释的事,就是没人去做
不要求每一行都加上,至少也要在一大块写点注释。功在当代,利在千秋呀!

代码规范很重要

代码风格一点都不统一,大家都按照自己的喜好来写代码,有人喜欢加分号,有人不喜欢;有人喜欢等号两边空格,有人就喜欢不加空格;有人的缩进是4个,有人的缩进是2个;有人用N年前的技术手段,有人喜欢用最新的技术方案。这样的代码一眼就能看出来是经历了多人之手,风格完全不一致。
这里没有代码规范一说,有检测代码的工具,却是摆设,没人使用,因为太严格,很多人不适应,随弃。
代码风格的好处是统一组员参差不齐的风格,使之很多人写出来就跟出自一人之手一样。

所加入的团队没有做好接口文档、注释、代码风格统一,接手的人处在泥塘中苦苦挣扎着。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容