V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
kyokuheishin
V2EX  ›  程序员

各位是否遇到过和代码实际行为不符的注释

  •  
  •   kyokuheishin · Jul 9, 2018 · 4039 views
    This topic created in 2851 days ago, the information mentioned may be changed or developed.

    TIM 图片 20180709112039.png 如图,最近在做学校网站 Android 客户端练手的时候想找 API,翻了半天代码找到这段,注释告诉我这个 URL 返回的是 JSON 字符串,我就尝试请求了一下结果返回的是 HTML ……顿时就有种想把写这段注释的日本程序员打一顿的想法

    14 replies    2018-07-09 12:39:26 +08:00
    lk1ngaa7
        1
    lk1ngaa7  
       Jul 9, 2018
    见得多了,就习惯了
    randyzhao
        2
    randyzhao  
       Jul 9, 2018
    很常见。。。
    大多都是需求和代码改了,注释忘改。
    要么就是:写个新模块,把老代码连同注释一起 copy 过去,但是注释根本不修改。
    mnssbe
        3
    mnssbe  
       Jul 9, 2018
    dataType: 'html',
    402645707
        4
    402645707  
       Jul 9, 2018
    打破了对日本人代码注释严谨的刻版印象
    kyokuheishin
        5
    kyokuheishin  
    OP
       Jul 9, 2018
    @mnssbe 不是 dataType 的问题,是内容就是 HTML
    singed
        6
    singed  
       Jul 9, 2018
    以前我干过
    dangyuluo
        7
    dangyuluo  
       Jul 9, 2018
    日本人的网站很多都是前台发 ajax 请求,后台直接生成 HTML 代码,插入 DOM 里完事。不知道为什么,国家风格?
    nongmei
        8
    nongmei  
       Jul 9, 2018
    见过很多:
    需求改了,代码改了,注释没改....
    dorentus
        9
    dorentus  
       Jul 9, 2018
    callback 的注释说的好像就是第一个参数是 html 吧……
    kyokuheishin
        10
    kyokuheishin  
    OP
       Jul 9, 2018 via iPhone
    @dorentus 我是直接对这个 URL 发 post 请求了 没用这个 Ajax 方法结果返回的就是 HTML
    jybox
        11
    jybox  
       Jul 9, 2018
    所以改了代码不想改注释的时候,就应该把注释删掉
    kyokuheishin
        12
    kyokuheishin  
    OP
       Jul 9, 2018 via iPhone
    @dorentus 懂了你的意思了,你是说 callback 的注释注明了返回的原始数据就是 HTML 对吧……那这个方法最上面的注释就很迷了
    teddybun
        13
    teddybun  
       Jul 9, 2018 via Android   ❤️ 1
    不但见过,还写过
    wly19960911
        14
    wly19960911  
       Jul 9, 2018
    别说了 今天我在看一个 angular 组件,修改逻辑,我给每个业务方法都 console.log 了,为的是搞清楚运行顺序。

    但是问题他最后 TM 居然在 extractData 拆装数据的方法写了业务逻辑,我们基本没有组件这么写得。我找了半天实现还以为是引用的组件改变了数据。

    我感觉这样可以叫做实际行为和取名(注释不符)的情况
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   4866 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 60ms · UTC 04:00 · PVG 12:00 · LAX 21:00 · JFK 00:00
    ♥ Do have faith in what you're doing.