pkookp8
V2EX  ›  问与答

怎么看待代码不准加注释的规则

  •  
  •   pkookp8 · Jan 19, 2019 via Android · 3862 views
    This topic created in 2701 days ago, the information mentioned may be changed or developed.
    第一次提交代码时有人 review 让我去掉注释,我以为是注释写的不好
    后来我复制同一项目内别人的代码顺带复制了注释,也让我去掉,而且还不是正式代码,是测试代码

    好奇怪的规定,但又不是明文规定
    24 replies    2019-01-20 10:52:37 +08:00
    zhazi
        1
    zhazi  
       Jan 19, 2019 via Android   ❤️ 1
    先问是不是,再问为什么
    规定靠猜的吗?
    binux
        2
    binux  
       Jan 19, 2019
    你确定不是注释掉的代码?
    然后,你干嘛要复制代码?而且是一段需要注释的代码。
    一段需要注释的代码说明它复杂到应该被重用,而不是被复制。
    pkookp8
        3
    pkookp8  
    OP
       Jan 19, 2019 via Android
    @zhazi 当然是说公司内部的规则,有什么好问是不是的

    @binux 不是,就是很普通的解释性的。因为是测试代码,改一个变量就行,要跑两次。代码结构上就不允许我做循环,不复制我敲一遍也没意义
    yidinghe
        4
    yidinghe  
       Jan 19, 2019 via Android
    Linux 内核代码不照样有很多注释。
    leekafai
        5
    leekafai  
       Jan 19, 2019 via Android
    外包项目吗?正常的。
    zhazi
        6
    zhazi  
       Jan 19, 2019 via Android
    不是明文规定你怎么知道是内部规定,
    是内部规定不问问为什么这么规定,
    跟你这人咋沟通费劲呢
    loading
        7
    loading  
       Jan 19, 2019 via Android
    提出这种要求的公司就是太菜了,对应这种这种需求,就应该有专门的清洗工具。
    dong3580
        8
    dong3580  
       Jan 19, 2019 via Android
    我们有个项目也是的,看领导要求了,review 时候要我删除注释,另外一个项目我就写了大量注释。前一个然后发现前几天维护的人看不懂之前写的代码的意思了,有趣。
    abcbuzhiming
        9
    abcbuzhiming  
       Jan 19, 2019
    @pkookp8 胡扯,内部规则?让它把规则明文拿出来,你说的那个人是谁,它有什么资格要你去掉注释?搞技术的还玩起暗箱操作来了?
    greatghoul
        10
    greatghoul  
       Jan 19, 2019
    @zhazi 同感
    coolcfan
        11
    coolcfan  
       Jan 19, 2019
    比如你的 reviewer 觉得这段代码没有注释我也看得懂,说明代码逻辑清晰,self-explaining,所以就不用加注释了呗?
    Solace202
        12
    Solace202  
       Jan 19, 2019 via Android
    刚来公司也是,试用期那会儿他没事 review 我代码,就说让我把注视删掉以后别写注释,我去,这完全不合理啊,不过也没怎么问,现在那主管走了换人了又说尽量写注释
    pkookp8
        13
    pkookp8  
    OP
       Jan 19, 2019 via Android
    原意是问问大家对加注释,或者不加注释怎么看
    删了就删了,我也没觉得啥。只是多了一次重新提交代码的步骤,又不是不给工资

    @leekafai 不是,公司内部项目
    pkookp8
        14
    pkookp8  
    OP
       Jan 19, 2019 via Android
    @abcbuzhiming 怎么这么纠结规则什么的呢,而且还升级到暗箱操作了。。。。
    可能我应该用规律,不应该用规则
    本来就没有这方面的规定,有的组就在加,我的组加了就得删,这样一个现象
    所以问大家对注释怎么看
    learnshare
        15
    learnshare  
       Jan 19, 2019
    难道是因为占了行数,会造成虚假工作量?
    Flicker
        16
    Flicker  
       Jan 19, 2019 via Android
    我公司 leader 比较注重代码的整洁,就规定最好别写注释,通过类,函数,变量的命名,函数抽象来确定代码的工作。
    但是我觉得复杂的场景还是要写点注释,注释也不一定正确,很多人也不会坚持维护注释。
    liuwei666666
        17
    liuwei666666  
       Jan 19, 2019
    现在沟通都得靠猜吗?
    猜来猜去,为什么不直接真诚的沟通呢?
    ResidualWind
        18
    ResidualWind  
       Jan 19, 2019
    @zhazi 就应该这样做,直接沟通,猜来猜去的 玩吗!
    micean
        19
    micean  
       Jan 19, 2019
    不靠注释难道靠命名?
    abcbuzhiming
        20
    abcbuzhiming  
       Jan 19, 2019
    @pkookp8 加了就得删?谁定的,凭什么?没规则,听谁的?你这不是暗箱操作是啥呢?
    laike9m
        21
    laike9m  
       Jan 19, 2019 via Android
    贴源码,看看到底需不需要注释,否则没法评价
    dajj
        22
    dajj  
       Jan 19, 2019
    我觉得注释尽量少,毕竟也是阅读成本。 不过用 IDE 的好多人,注释自动加上,愁。
    每个文件都加上了注释, 表明了 编辑器,作者,日期。。。
    好烦这个啊, 毛线用都没有。
    fairyto2
        23
    fairyto2  
       Jan 20, 2019 via iPhone
    @dajj 加了作者,责任到人,方便追责,多好
    dajj
        24
    dajj  
       Jan 20, 2019
    @fairyto2 不可能的。 文件没有分配责任到人。 另外人员变动怎么办? 所有相关文件全改下名字? 其实版本管理中已经记录了所有的信息, 所以记录这个纯粹是浪费别人阅读时间。
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   3927 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 100ms · UTC 04:16 · PVG 12:16 · LAX 21:16 · JFK 00:16
    ♥ Do have faith in what you're doing.