V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
coocier
V2EX  ›  程序员

用 git 却习惯用注释而不是删除多余代码是怎样的心态

  •  
  •   coocier · 2019-08-28 16:37:01 +08:00 · 4858 次点击
    这是一个创建于 1675 天前的主题,其中的信息可能已经有所发展或是发生改变。
    团队成员中总有人不喜欢把多余的代码删除,而是变成注释留在哪里,可是明明有在使用版本管理软件啊,照理说所有的更改都可以找回啊,就搞不懂为什么一定要把没用的代码留在那里,搞得整个项目随处可见一堆没用的注释代码。
    32 条回复    2019-08-29 11:52:31 +08:00
    whitehack
        1
    whitehack  
       2019-08-28 16:40:27 +08:00
    我也这样做。。。觉得这样方便。比去查 git 方便。。。
    ackfin01
        2
    ackfin01  
       2019-08-28 16:45:49 +08:00
    有些注释代码可能短时间后面还得弄回来,就注释了,方便点。确定不要的直接就删了。
    lowman
        3
    lowman  
       2019-08-28 16:49:02 +08:00
    有时是方便调试, 有时候是因为这段代码所实现的业务当前不需要了, 但是不保证后续不再继续启用, 很正常...........重要的是,直接注释掉更直观.....当然, 如果太多了也会影响代码阅读
    babedoll
        4
    babedoll  
       2019-08-28 16:52:48 +08:00
    =。=因为可能以后还要用。。或者以后可能要照着写

    我们有#region 还算比较清爽
    glaucus
        5
    glaucus  
       2019-08-28 16:53:49 +08:00
    一两行那种代码我会注释,因为方便,整个代码块的我还是会删掉,用的时候去 git 记录里找
    uhian
        6
    uhian  
       2019-08-28 16:55:33 +08:00 via iPhone
    给想改的人看看,这么写不对啊,以后不要走弯路,没注释的是对的😄
    xenme
        7
    xenme  
       2019-08-28 16:55:45 +08:00 via iPhone
    然后你都不记得以前写过,每次都造新轮子。
    留着注释每次都能看到,🐶
    ccyu220
        8
    ccyu220  
       2019-08-28 16:55:56 +08:00
    不注释的代码基本上都是个人调试用的。
    chendy
        9
    chendy  
       2019-08-28 16:57:06 +08:00
    临时注释掉,觉得以后可能会翻出来继续用,结果一直没用,就会留在那里…
    要么定期清理,要么假装没看见…
    IanPeverell
        10
    IanPeverell  
       2019-08-28 17:01:32 +08:00
    开发阶段,把之前稳定的代码注释掉短期内恢复比较方便,等新代码确认没什么问题了就可以把注释删掉了
    我是这么想的
    不过如果注释太长了,当然也会直接删掉的不然看起来太恶心了
    linxl
        11
    linxl  
       2019-08-28 17:20:49 +08:00
    直观, 删了哪天就忘了.
    sdxlh007
        12
    sdxlh007  
       2019-08-28 17:23:22 +08:00
    有时候还可能要用,我也经常不删。。。
    zafnks
        13
    zafnks  
       2019-08-28 17:34:18 +08:00
    管好自己别管别人
    mxq0923
        14
    mxq0923  
       2019-08-28 17:41:49 +08:00
    这个我觉得可以弄个编辑器插件开关隐藏注释解决
    yvescheung
        15
    yvescheung  
       2019-08-28 17:42:03 +08:00
    你能耐下心来到 git 历史中找你一两个月前删除的代码么?
    harde
        16
    harde  
       2019-08-28 17:49:43 +08:00   ❤️ 4
    当你遇到一个 6000 多行代码,3000 多行注释的程序,你的领导告诉你,之前 XXX (上任或上上任或上上上任接受的程序员)做过,你找找历史拿出来直接用就行。
    楼上的就不会 BB 了。

    当然,这种情况,找 Git 历史也不见得是什么好操作。
    因为你会发现,一个模块,修改记录 100+,merge 了 N 次,查看注释都是
    修正 AAA、修正 AAA、再次修正 AAA、AAA 改回 BBB、BBB 再次改回 AAA 得一堆无用注释。

    真的,公司没有编码规范、上传规范或者编码、提交规范没有执行力度的代码写注释也好,git 记录也好。
    都没有什么实际意义。
    Mark24
        17
    Mark24  
       2019-08-28 19:11:35 +08:00
    我现在觉得,删除无用代码比较好。
    代码历史交给 git 来做
    TimPeake
        18
    TimPeake  
       2019-08-28 19:15:51 +08:00   ❤️ 1
    大概率是该程序员经历过:“ 哎,上次的那个功能不是去掉了吗,这个版本再加上吧。”
    xiubin
        19
    xiubin  
       2019-08-28 19:39:52 +08:00 via iPhone
    @harde #16 老哥是过来人啊

    我注释代码被删后过了半年,要去找回来。那酸爽....
    cigarzh
        20
    cigarzh  
       2019-08-28 19:41:06 +08:00
    我就觉得不确定的代码注释掉比较好,不怎么影响可读性又比 git log 直观
    blindie
        21
    blindie  
       2019-08-28 19:48:43 +08:00
    我的经历是注释着以为后面能用上的代码基本上是用不上。留着纯粹是不想删而已。
    Lax
        22
    Lax  
       2019-08-28 20:47:08 +08:00
    按行数计算工作量
    ClericPy
        23
    ClericPy  
       2019-08-29 01:25:32 +08:00
    有时候用在调试一些东西, 正常跑就不需要那些 patch
    有时候是当作 template code 给别人模仿着抄的
    有时候是改掉了其他人的代码, 但是又对他代码不熟悉怕改坏, 临时注释
    可能性太多了, 有代码洁癖也会被层出不穷的 bug 改掉的, 因为懒得写测试啊
    Inside
        24
    Inside  
       2019-08-29 09:41:53 +08:00   ❤️ 2
    楼上一群人莫不是从来不用分支管理?写代码的时候本地难道不起个私人分支,让自己知道这个分支是干嘛的?
    如果你觉得代码可能需要保留不想删,那这个本地分支哪怕合并到主干之后也别删。

    而且你们是不是从来没有给社区贡献过代码,没经历过开源协作,你们去看看多少开源项目会允许你把可能用到不想删的代码用注释留着,发个 PR 看看别人会接受不?
    aa543187001
        25
    aa543187001  
       2019-08-29 10:07:19 +08:00
    可能要用留着不删 然后注释掉,都是给后来看代码的人增加负担,还影响阅读,我现在都是帮人家删了,要用的人自然会找 log 拉回来。
    NDMXXSMX
        26
    NDMXXSMX  
       2019-08-29 10:11:03 +08:00
    注释了方便啊,翻 git
    hackshen
        27
    hackshen  
       2019-08-29 10:14:04 +08:00
    既然注释了,肯定以后用得着的
    hjq98765
        28
    hjq98765  
       2019-08-29 10:38:54 +08:00
    昨天 领导:这个 1.0 版本 xxx 要加在 json 里输出
    我:好

    今天 领导:2.0 版 xxx 用不到了,你把它从 json 里删掉
    我:下游不解析这个字段删不删无所谓吧
    领导:不行,就算下游不解析这个字段你也要删掉,必须删
    我:听领导的

    明天 领导:3.0 版还是要把 xxx 输出的,2.0 出了一堆 bug 都是因为解析不到 xxx
    我:???
    领导:赶紧的,今晚上线
    我:(还好我只是注释掉了,正好跟领导说我之前删掉的代码找不到了,得重新写,估计今天下午只能赶紧干这个了,那个啥啥啥就有理由拖一拖了)
    smallpython
        29
    smallpython  
       2019-08-29 10:40:45 +08:00
    不觉得注释影响美观
    因为 ide 把注释都给折叠起来了......
    Jiavwen
        30
    Jiavwen  
       2019-08-29 11:29:43 +08:00
    @babedoll 我是非常不喜欢#region 的,嫌多于就把它抽出去,留着 region 最后一个类里面几百上千行
    519718366
        31
    519718366  
       2019-08-29 11:51:07 +08:00
    注释代码,不给代码加注释原因的话,那还是删代码吧
    不然天知道这个注释代码是为了开发方便忘记注释回来了(比如释掉某个校验为自己测试方便点),还是怎么滴...
    aa543187001
        32
    aa543187001  
       2019-08-29 11:52:31 +08:00
    @smallpython //的注释还能折叠嘛 一行代码 2 行 // 一行代码 2 行 // 还不影响美观吗
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   2861 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 14:29 · PVG 22:29 · LAX 07:29 · JFK 10:29
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.