V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
jelinet
V2EX  ›  职场话题

同事离职,代码交接给我,基本没什么注释,还不愿意写文档。

  •  
  •   jelinet · 2015-06-18 16:24:11 +08:00 · 17062 次点击
    这是一个创建于 3427 天前的主题,其中的信息可能已经有所发展或是发生改变。
    如题所述。大体是这样。现在这个同事正在我旁边啪啪啪的敲着键盘表示他的不满。因为他明天就想离职。
    可是,可是,代码真的没注释啊。这个东西怎么运行起来我都母鸡啊。就写个大概流程文档,叙述一下主要的方法函数干啥用的,参数返回值啥的,这难道过分吗。。。可能对于他明天想离职,是有点过分。但是没有文档也很难为我啊。
    这种问题一般大家都咋对待,是无所谓心态,以后代码自己看吧,随便交接一下;还是必须要交接好。
    第 1 条附言  ·  2015-06-19 14:51:24 +08:00
    谢大家回复。。我目前准备做好接盘侠工作了。。。
    71 条回复    2015-06-23 16:28:32 +08:00
    bengol
        1
    bengol  
       2015-06-18 16:29:23 +08:00
    没注释属于正常现象吧,淡定
    iannil
        2
    iannil  
       2015-06-18 16:29:51 +08:00
    敞开来说嘛,离职是对公司不满又不是对你不满,跟你能有啥仇,等他没那么大火气的时候跟他提一下呗。

    如果他离职就是因为你,那,基本就无解了,纯属故意的嘛。
    zhchaos
        3
    zhchaos  
       2015-06-18 16:30:02 +08:00
    都是自己看吧,我原先也是这样接别人的,么办法,俗称接盘侠
    zjuster
        4
    zjuster  
       2015-06-18 16:31:05 +08:00
    没交接好还想明天离职?公司放人?
    lyragosa
        5
    lyragosa  
       2015-06-18 16:31:22 +08:00
    我接的这种东西多了……

    习惯了就好了。
    lichao
        6
    lichao  
       2015-06-18 16:35:37 +08:00
    明天离职,今天才写文档?

    如果是非常小的项目,一天时间差不多能写写。

    稍微大点的项目,一天时间也写不了什么。

    公司制度不到位,没人审查代码,活该。

    想想看以后怎么避免这种情况吧。
    yuankui
        7
    yuankui  
       2015-06-18 16:37:58 +08:00
    直接把它拉到你面前,让他给你讲嘛
    写文档效率多低啊..
    fghfjujiber
        8
    fghfjujiber  
       2015-06-18 16:50:57 +08:00
    @yuankui 赞成!
    mrhhsg
        9
    mrhhsg  
       2015-06-18 16:51:46 +08:00
    呵呵,乃们遇到过给公司留下一堆so库和头文件的么?
    FrankFang128
        10
    FrankFang128  
       2015-06-18 16:52:55 +08:00
    我离职怎么要写一周的文档……
    learnshare
        11
    learnshare  
       2015-06-18 16:55:19 +08:00
    通常都不写文档,但写起文档来,就得当成正经事。
    tini20
        12
    tini20  
       2015-06-18 17:06:51 +08:00
    正常
    jelinet
        13
    jelinet  
    OP
       2015-06-18 17:14:04 +08:00
    @zjuster 公司比较逗逼。提了离职一个月了,一直安排修bug,然后最后一星期了,开始交接。。。
    jelinet
        14
    jelinet  
    OP
       2015-06-18 17:14:47 +08:00
    @lichao 项目到都是不太大。。主要是多啊。。。留了11个项目。简直吐血啊。
    akira
        15
    akira  
       2015-06-18 17:15:03 +08:00
    有源代码就该知足了。。
    jelinet
        16
    jelinet  
    OP
       2015-06-18 17:16:47 +08:00
    @yuankui 留了11个项目。实话说我刚进半年,现在工作就是把以前的产品推了重写。口头讲,真的,11个项目讲一下午,我脑袋真的大了。所以我想要一个文档。以后还可以再看看的。
    jelinet
        17
    jelinet  
    OP
       2015-06-18 17:18:54 +08:00
    看到大家都说正常。。。那我。。摸摸看代码去好了。。。。其实我这边是,我也想离职啊。留这么多项目下来,以后我走的时候,我都没法交接。。。。
    jelinet
        18
    jelinet  
    OP
       2015-06-18 17:20:02 +08:00
    @zhchaos 好大一个接盘侠。。泪目。。
    soli
        19
    soli  
       2015-06-18 17:20:31 +08:00
    直接当面讲更快。
    jelinet
        20
    jelinet  
    OP
       2015-06-18 17:21:08 +08:00
    @learnshare 我赞成,因为领会了没文档的痛苦。。。。而现在的逗逼公司就是啥文档没有,主要靠人和人口述。。。。简直。。。
    jelinet
        21
    jelinet  
    OP
       2015-06-18 17:22:52 +08:00
    @iannil 没,跟同事关系还不错。只是我今天提出让他给个文档的时候,看着他挺不爽的。。。但工作是工作。是工作就做好呗。。。不写注释这种事情,早晚会还回来的。。。
    pimin
        22
    pimin  
       2015-06-18 17:26:46 +08:00
    @jelinet
    问题是他还还是你还!
    啊哈哈
    zhchaos
        23
    zhchaos  
       2015-06-18 17:27:28 +08:00
    @jelinet 哈哈
    sacuba
        24
    sacuba  
       2015-06-18 17:29:26 +08:00
    离职不是提前一个月么 这一个月就是用来写文档的 哈哈
    iannil
        25
    iannil  
       2015-06-18 17:34:52 +08:00
    @jelinet 要么等他火过了再问一下,要么就退而求其次,文档可以没有,至少对着项目介绍一下是可以的,回头你再自己整理成文档呗。

    有一句话你说的对,不顾及团队的人,会被团队所不顾及。迟早会还的,啊哈哈
    coetzee
        26
    coetzee  
       2015-06-18 17:38:55 +08:00
    关于注释和文档,我一直认为在良好的设计和命名规范之下,没有那么重要。而且注释和文档并不能完美表达出来意思,反而有时候会造成反面影响,但是代码比较诚实,还是看源码!!!
    caixiexin
        27
    caixiexin  
       2015-06-18 17:41:01 +08:00
    如果工作没交接清楚,公司有权利不放人吧,离职提前一个月提就是这么用的。
    我记得我们这边同事离职的时候,各个环节都有人交接,交接人觉得没问题了签字了才能往下走。
    dahvlh
        28
    dahvlh  
       2015-06-18 17:45:12 +08:00
    公司这安排
    gamecreating
        29
    gamecreating  
       2015-06-18 18:02:08 +08:00
    你很懒..你起码得把整个项目代码看一遍 将来才能当CTO迎娶白富美....
    你竟然不愿意学习
    qvvo
        30
    qvvo  
       2015-06-18 18:33:15 +08:00
    这是公司的问题,离职提了一个月,最后一个星期才让交接,
    楼主以后也会遇到这种情况的,这种公司和领导,你长点心吧
    dd99iii
        31
    dd99iii  
       2015-06-18 19:24:17 +08:00
    唉。。。楼主不妨开始投简历
    liubiantao
        32
    liubiantao  
       2015-06-18 19:51:38 +08:00
    @caixiexin 现在的问题是,人家确实早就提前一个月提离职了,可是公司一直不让他交接,而是一直压榨他,非要拖到最后才让他交接,他当然不爽了。
    wezzard
        33
    wezzard  
       2015-06-18 20:20:12 +08:00
    Are you writing in strongly semantic language such as Objective-C or Swift?
    imcj
        34
    imcj  
       2015-06-18 22:18:59 +08:00 via iPhone
    你对文档有什么要求?写下来然后问问自己做到了吗?如果文档是公司工作成功的标准,他肯定会写。

    为什么总有人接个盘就上网瞎逼逼,你这种人就是作。
    msg7086
        35
    msg7086  
       2015-06-18 22:21:28 +08:00
    这公司坑吧,赶紧离了吧……
    df4VW
        36
    df4VW  
       2015-06-18 23:09:39 +08:00
    如果是perl,他可能不是不想写,是自己发现也看不懂了
    jadetang
        37
    jadetang  
       2015-06-18 23:43:38 +08:00
    也有可能他也是接的别人的项目。
    kanezeng
        38
    kanezeng  
       2015-06-18 23:51:38 +08:00   ❤️ 2
    习惯了额就好,程序员四大恨:
    1、写注释
    2、写文档
    3、别人不写注释
    4、别人不写文档
    newobux
        39
    newobux  
       2015-06-19 00:14:29 +08:00
    11个项目是你前同事一个人做的?并且还再迭代?
    codeface
        40
    codeface  
       2015-06-19 00:24:17 +08:00
    @mrhhsg 这个太绝了。。。
    anerevol
        41
    anerevol  
       2015-06-19 00:28:58 +08:00
    对于做iOS开发来说,一般文档就是写给领导看的。
    话说最近也在做接盘侠,看到几千行代码几十个成员变量的类,觉得就算有文档写得再好看也没啥用。
    cralison
        42
    cralison  
       2015-06-19 07:44:35 +08:00
    我接的也是这样。还不是特别小的产品。
    19日入职,20日就开始修Bug做新功能了。这代码已经经过几个人的手,上一任才来2个月,就算让他讲,他也讲不清楚,更别说文档了。
    代码就那么回事,只要不是太底层的依靠数理基础的,基本还是可以理清的。当然速度会慢一些。
    入职一个月,分析代码的能力暴涨。

    编程,无非是数据和针对数据的操作。有一个技巧,拿一排有序数据堆进去,看看输出变化,大概就能猜出是要对数据进行什么样的操作了。
    ybh37
        43
    ybh37  
       2015-06-19 08:08:33 +08:00
    交接是要有制度来规范的,不是你说啥就是啥!你们平时都不写注释、文档,现在你跟人家说需要补齐,这就是难为人家了。好聚好散~
    xinran505982
        44
    xinran505982  
       2015-06-19 08:54:20 +08:00 via Android
    看情况了,我的本来就是有注释的,有时候就是故意,把文档注释用工具全删除,连空行都删除,再提交。而有时候就有很详细的提交。
    xinran505982
        45
    xinran505982  
       2015-06-19 08:56:50 +08:00 via Android
    很小人一起做事就一点注释文档都不留,全删除,否则就很详细。
    327beckham
        46
    327beckham  
       2015-06-19 09:00:30 +08:00
    我怎么觉得,这挺正常的。。。。我都习惯了,还能提高自己阅读代码的能力
    jelinet
        47
    jelinet  
    OP
       2015-06-19 09:07:48 +08:00
    @imcj 我对文档的要求我说过了,就是把业务复杂的地方,方法名字,参数字段,返回值字段代表了什么表示清楚,变量名都瞎起的这样的工作态度我不能理解。我也离过职,我做到了这一点。并且我做的比这个详细。并且我当时也是用了一个星期写完的。
    不明你的喷点在哪。
    madmen
        48
    madmen  
       2015-06-19 09:08:32 +08:00
    接多了你就习惯了,而且你还会发现乐趣。
    哦,原来是这样啊,啊哈哈哈。。。
    jelinet
        49
    jelinet  
    OP
       2015-06-19 09:12:41 +08:00
    @dd99iii
    @msg7086

    没错,坑的要命,早就想离了。。
    这领导也是非常逗逼,每次请假都要问我干吗去。。。。
    更逗逼的是前些天入职了一个应届毕业生,待了一星期吧,说代码实在看不懂,要回家。然后前天早上离职了。。。。
    jelinet
        50
    jelinet  
    OP
       2015-06-19 09:17:32 +08:00
    @madmen 以前也不是没接过。。。就是真心没接过代码质量这么差的。。。比如需要操作数据库的,最起码跟数据库字段命名一样吧,复制粘贴的事。。这都瞎起的。。。真是哔了狗了
    jelinet
        51
    jelinet  
    OP
       2015-06-19 09:19:35 +08:00
    @ybh37 我平时写注释,写文档。可能是因为我做的工作是推翻旧产品,重新写。所以自己自觉的写了一些文档。。。也主要想别人接手时能痛快点。。这样也有利于我去做别的工作。不然就永远绑在同一个地方了。。。
    lucky2touch
        52
    lucky2touch  
       2015-06-19 09:53:17 +08:00
    能看懂别人的代码也是锻炼之一......不过我说的是结构良好,思路清晰的代码:)
    xujialiang
        53
    xujialiang  
       2015-06-19 10:02:33 +08:00
    说明平时没有code review
    msg7086
        54
    msg7086  
       2015-06-19 11:13:33 +08:00
    @jelinet 好的代码很少需要注释。
    (我说的好的代码,我的意思是带有完整测试并且编写良好的代码)
    madmen
        55
    madmen  
       2015-06-19 12:22:23 +08:00
    @jelinet 这个故事告诉我们 如果有机会培养新人 一定要盯住编码规范这一块,一旦坏的习惯养成 对公司,对这个人的将来都是灾难。
    caigaopei
        56
    caigaopei  
       2015-06-19 15:35:00 +08:00
    一点可以说明制度不到位,还有就是要离职的那位同事平时对自己比较松散,代码写注释是最基本的规范,但是遇到这个事情了也只能硬着头皮去梳理了,毕竟也是你的本职工作,换个角度来看,说不定也能吸取到好的东西,毕竟能看懂别人写的东西是一件很伟大的事情... 平常心 平常心!!!
    jelinet
        57
    jelinet  
    OP
       2015-06-19 15:44:06 +08:00
    @caigaopei 谢。说的很中肯。
    eeeeeeve
        58
    eeeeeeve  
       2015-06-19 16:21:07 +08:00
    同时工作多久了,为何离职?
    maxbon
        59
    maxbon  
       2015-06-19 16:40:43 +08:00
    公司现在3个项目,源代码全部被前离职员工删掉了,没注释。想当初我从上家公司离职的时候可以花了很长时间把注释和文档全部加上去了的。唉,别人没职业道德没办法,只能靠自己填坑
    jelinet
        60
    jelinet  
    OP
       2015-06-19 17:02:10 +08:00
    @maxbon 删掉这得多大的仇啊。。。
    maxbon
        61
    maxbon  
       2015-06-19 17:14:14 +08:00
    @jelinet -。-好像是和COO不对眼吧,然后直接被干掉了,然后那货直接删源码删数据库,还好数据库有备份
    huobazi
        62
    huobazi  
       2015-06-19 17:18:20 +08:00
    这不是他的错 是老板的错
    jydeng
        63
    jydeng  
       2015-06-19 23:33:24 +08:00
    我也要跑路了,我们这公司之前几个实习生,现在就剩我了。本来分给几个人维护的项目,现在也都丢给我,hold不住,拿了毕业证就走人,就是不懂怎么交接了。
    beimenjun
        64
    beimenjun  
       2015-06-20 10:42:14 +08:00
    1.看代码的难度其实多数时候是超过写代码的。
    2.好的程序员应该尽量写出不用注释就能明白的代码。
    Elight
        65
    Elight  
       2015-06-21 13:05:28 +08:00
    看代码比写代码还要难,没有注释不是难为人吗?
    alphonsez
        66
    alphonsez  
       2015-06-21 15:26:11 +08:00
    代码是最准确的,文档神马的都是浮云。让他大概讲一下这个在干啥就行了。
    NovemberEleven
        67
    NovemberEleven  
       2015-06-22 11:27:48 +08:00
    我接手的也是没有文档的。
    xpol
        68
    xpol  
       2015-06-22 12:27:16 +08:00 via iPad
    结对编程、code review都是能避免楼主悲剧的实践。

    然而现实就是公司急着实现功能,加班还来不及呢,还代码公有制呢。
    riverphoenix
        69
    riverphoenix  
       2015-06-22 18:05:08 +08:00
    唉,最近一次离职,给那个同事整整讲了一个月,就他妈四个页面,后面两个主要的函数,到现在还在问我什么是干嘛用的,
    jelinet
        70
    jelinet  
    OP
       2015-06-23 10:32:40 +08:00
    看了大家说的。。。也都是辛苦了。。。。。我还是too young
    VirgilMing
        71
    VirgilMing  
       2015-06-23 16:28:32 +08:00
    @coetzee

    > 关于注释和文档,我一直认为在良好的设计和命名规范之下,没有那么重要。

    有「良好的设计和命名规范」的项目,应该根本不会遇到注释和文档的问题……你在缘木求鱼。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   5622 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 30ms · UTC 06:39 · PVG 14:39 · LAX 22:39 · JFK 01:39
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.