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

2018-07-09 10:26:52 +08:00
 kyokuheishin

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

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

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

我感觉这样可以叫做实际行为和取名(注释不符)的情况

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/469193

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX