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

以前很难理解老程序员不写注释,不写文档,代码不规范,命名不规范。现在开始懂了。。。

  •  1
     
  •   jeremylai · 2023-03-07 14:07:43 +08:00 · 18616 次点击
    这是一个创建于 388 天前的主题,其中的信息可能已经有所发展或是发生改变。

    以前接手别人写的代码,到老员工代码,一个注释都没有,运气好的话,有人给你解释以前的业务逻辑,或者给你看以前的文档。要是运气不好的话,只能自己慢慢琢磨了。

    后面写注释,命名规范,代码规范,写文档。开发也花了更多的时间。

    后面想想,代码的可读性越强,你的可替代性不也是越强吗?花更多的时间,优化自己。

    第 1 条附言  ·  2023-03-08 09:35:47 +08:00

    很多人都把注意力放在被优化上,我只是说被优化的难度就减少,不是说不会被优化,老板一句话就可以让你滚。

    还有老哥以为我要故意写错代码,故意写不好代码,不也得花时间吗?我的意思是基本符合规范就可以了,怎么方便怎么来,花时间在做规范,注解,写相关文档上,那就得不偿失了。

    124 条回复    2023-03-09 17:26:04 +08:00
    1  2  
    bk201
        101
    bk201  
       2023-03-08 09:49:02 +08:00   ❤️ 1
    写注释是给自己以后看的,而不是给后面接手人看的,如果自己能看懂,就没必要写注释。代码原则就是没注释能看懂的代码是最好的。
    someonetwo
        102
    someonetwo  
       2023-03-08 09:56:58 +08:00
    这么做感觉是在糟践自己,把自己往一条下坡路引
    852228187
        103
    852228187  
       2023-03-08 10:01:17 +08:00
    这么做感觉是在糟践自己,把自己往一条下坡路引
    Erroad
        104
    Erroad  
       2023-03-08 10:04:50 +08:00
    好的架构是演化出来的,不去演化继续赶工自然就劣化了,再加上你没有前人的上下文,自然就看不懂了,这些甚至不需要可以为之。
    而且最近写了些有设计的代码,别人也看不懂,因为代码不够线性(像面条)了
    killeder
        105
    killeder  
       2023-03-08 10:14:17 +08:00
    我以前也是老老实实写注释,但是自从来了一个哥们,把注释换一个风格,变量名和函数名换一下并成自己的成果去捞功劳后,我再也不想写注释了,尤其是逻辑越复杂的越不想写,写就写最简单的那种。
    xylxAdai
        106
    xylxAdai  
       2023-03-08 11:14:21 +08:00
    注释一般我也不会写的,但不是因为可替代性,而是很多逻辑和业务代码是不需要注释的,我觉得自己的命名规范、逻辑都是不错的,看我代码不会有迷惑的点。除非是那种其他包的参数、特殊值会备注一下地点和作用。
    而且代码写的可读性越强,对自己来说长期绝对是利好的,至少技术、逻辑、人品都是展示给所有人看的。
    什么不可替代性,都是自己骗自己的,老板要开你,难道还问你领导:这个项目是不是缺他就干不了?
    raptor
        107
    raptor  
       2023-03-08 11:16:16 +08:00
    归根到底一句话:萝卜快了不洗泥。

    老板又不为这些工作付钱,需求那么多,时间人手就那么些,当然是怎么快怎么来。

    比如正常一个需求,完成开发需要时间为 N ,加上文档可能要 2N ,再加测试可能要 3N ,但老板通常只会给你 N/2 的时间,你说怎么办?
    Light1226
        108
    Light1226  
       2023-03-08 11:30:15 +08:00
    @ghostben 加入代码已经发布了,那怎么办,每次 clone 下来还能看到之前的注释吗?
    violetlai
        109
    violetlai  
       2023-03-08 11:35:04 +08:00
    其实变量名命名清晰点 直接 chatgpt 生成注释就很好了
    NoKey
        110
    NoKey  
       2023-03-08 11:42:17 +08:00
    你们没有代码 review 么。。。。
    opentrade
        111
    opentrade  
       2023-03-08 11:57:09 +08:00
    水货程序员整天纠结注释
    lamesbond
        112
    lamesbond  
       2023-03-08 12:34:35 +08:00
    你就说能不能用吧
    lllllllccccccc
        113
    lllllllccccccc  
       2023-03-08 13:36:15 +08:00
    除了高精尖的外,其余的基本上一水的 CV ,管你写不写,你就是写的天书,大不了我重新实现一下
    nmap
        114
    nmap  
       2023-03-08 17:08:34 +08:00
    又不是不能用.jpg
    nmap
        115
    nmap  
       2023-03-08 17:10:16 +08:00
    @ghostben #25 思路不错啊,抓到痛点了
    imnpc
        116
    imnpc  
       2023-03-08 17:24:38 +08:00
    正常开发过程中都写注释的 但是后期迭代快的时候 客户一直改需求的时候 注释就不会写的那么多了
    ac23
        117
    ac23  
       2023-03-08 18:10:42 +08:00
    @vagranth 哈哈,之前参加了一个屎山项目,深有体会
    anc95
        118
    anc95  
       2023-03-08 18:26:32 +08:00
    你好,理解你的痛苦。接手别人写的代码,一般需要先了解这段代码的业务逻辑,以及原有代码的命名规范和格式。要是运气好的话,有人给你解释以前的业务逻辑,或者给你看以前的文档,要是运气不好的话,只能自己慢慢琢磨了。因此,维护起来也花了更多的时间,比如写注释,命名规范,代码规范,写文档等等。对于你自己的代码也是如此,细心考虑,花点时间看看能不能将可读性提高,让自己的代码更容易维护。可读性越强,你的可替代性不也是越强吗?让你的代码可以带给其他人更多的快乐,也是值得花费点时间的。
    huihuilang
        119
    huihuilang  
       2023-03-08 18:37:42 +08:00 via Android
    @j717273419 说的很对,国外大厂文档真是做得真是好,有时候也在想什么时候写出那么好的文档,但是一看工期每天都赶得不行哪有空写文档,唯一一次写文档还是过年前大家都休息了自己有时间整理思路写文档
    honmaple
        120
    honmaple  
       2023-03-08 19:19:58 +08:00
    你是没见到一句代码没写就要写开发文档的公司,五天的开发时间,一天写文档,一天对文档,一天改文档,一天开发,半天测试,再来半天继续改文档,你以为改的是开发文档,使用详情,其实是不能用 markdown ,要用 word ,xx 标题要用宋体,小四,xx 流程图不能用蓝色,要用红色,1+2 不能直接等于 3 ,需要改成 1+1+1 ,问了一下这文档最后谁看,嗯,就他和大 boss 看,只对内。。。
    nsynet57
        121
    nsynet57  
       2023-03-08 23:02:08 +08:00
    正规一点的公司都有编程规范,比如不能有魔鬼数字等等,当然实际操作看管理能力了
    HarrisonZ
        122
    HarrisonZ  
       2023-03-09 09:56:11 +08:00
    我现在都是贴代码给 chatgpt ,让 gpt 给我加注释
    vincent7245
        123
    vincent7245  
       2023-03-09 10:32:51 +08:00
    没有那么复杂,就是时间太紧,钱没给够
    weivi
        124
    weivi  
       2023-03-09 17:26:04 +08:00
    系统逻辑复杂,又不写注释,最后恶心的还是自己
    1  2  
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   2870 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 33ms · UTC 11:28 · PVG 19:28 · LAX 04:28 · JFK 07:28
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.