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

命名规范与注释哪个更重要?

  •  
  •   wtl · 2011-08-07 22:32:07 +08:00 · 5527 次点击
    这是一个创建于 4843 天前的主题,其中的信息可能已经有所发展或是发生改变。
    吐槽一下 窃以注释没空可以不写 命名一定要规范
    不少人写的代码很让人受不了 随意简写变量名及方法名
    看代码非要时不时去看注释 又恶心又累
    多打两个字 名字本身即是注释
    何必呢?
    12 条回复    1970-01-01 08:00:00 +08:00
    dongsheng
        1
    dongsheng  
       2011-08-07 22:38:10 +08:00
    命名是件纠结的事,好的命名是高质量代码的重要部分
    fluke
        2
    fluke  
       2011-08-07 22:41:52 +08:00
    两个都重要,好的命名可以节省注释。
    Harry
        3
    Harry  
       2011-08-07 23:07:16 +08:00
    更重要的是命名。一个好的命名本身就是注释,而且是好的注释。
    zythum
        4
    zythum  
       2011-08-07 23:12:39 +08:00
    只要能让下个人可以方便得看懂就好。
    glume
        5
    glume  
       2011-08-23 00:25:19 +08:00
    两手抓,两手都要硬。
    pinepara
        6
    pinepara  
       2011-08-23 00:40:31 +08:00
    好的代码应该是自注释的。
    不涉及到复杂算法的地方应该让代码不依赖注释也完全可读。
    wtl
        7
    wtl  
    OP
       2011-08-23 15:45:26 +08:00
    @pinepara 深以为然!
    tox
        8
    tox  
       2011-08-23 16:14:14 +08:00
    一直注意命名问题,现在注释很少写,以后要改。
    项目紧的话,有时命名也很坑。
    orzzzzz
        9
    orzzzzz  
       2011-08-23 17:53:29 +08:00
    两码事,都很重要...不能相互替代,只能说相互增益.
    命名可以说明的注释就不是需要的注释....但并不是说,只要有好的命名了,就不需要注释了.
    --
    回头补注释的机会很微....当然,你会想,重构的时候再....咳咳...
    dogFish
        10
    dogFish  
       2011-08-23 17:58:05 +08:00
    webkit的代码里就很少有注释, 因为变量函数命名清晰易懂
    myrual
        11
    myrual  
       2011-08-23 18:02:58 +08:00
    能够自解释的代码会好很多。
    但是自解释的效果和文字表达能力有关。
    同时自解释的效果也和程序工作原理有关,如果基于某个复杂的数据结构或者算法,自解释也没意义。
    如果代码设计是按着业务流程的来设计的话,那么维护的难度会简单很多。
    如果是按着内部如何实现的方法来设计的话,那么维护的难度会大一点,毕竟维护者要理解技术上是怎么实现的,并且理解业务和技术实现如何连接的
    obiwong
        12
    obiwong  
       2011-08-28 21:48:51 +08:00
    减法和加法哪个更重要?
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2609 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 22ms · UTC 02:51 · PVG 10:51 · LAX 18:51 · JFK 21:51
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.