同事写的注释实在太多余了

2020-08-23 13:18:32 +08:00
 wuzhouhui
例如声明变量和函数之前, 都要写一行注释

// 声明变量
// 声明函数

大家都是成年人, 哪有人不知道这是在声明, 至于写个注释吗? 放锁写个注释, 解锁再写个注释. 都三十好几的人了, 也不看看其他人是怎么写代码的, 都说了不要写多余的注释, 还不肯改
16327 次点击
所在节点    程序员
103 条回复
NotFoundEgg
2020-08-24 08:53:05 +08:00
写也不行 不写也不行
他写这种废话注释 大概率写别的代码也会写注释
总好过那些一点注释不写的人
kemikemian
2020-08-24 08:53:16 +08:00
碍着你写 bug 了?
我反正觉得这种人很牛
l00t
2020-08-24 08:55:35 +08:00
@imn1 #26 然后他加的注释是: 声明变量 a, 声明变量 a1, 声明变量 a2……
quan01994
2020-08-24 08:56:46 +08:00
注释还是多写一写。。业务流程一大堆的时候,你就知道注释有多么重要,当然可有可无的,也不会影响什么,
只要不写错误的注释就行。
12tall
2020-08-24 08:59:47 +08:00
如果有很多变量放一起声明,我倒是很喜欢你同事的这种注释
Vitta
2020-08-24 09:08:20 +08:00
我自己的代码我自己都看不懂,包括变量
vipppppp
2020-08-24 09:30:42 +08:00
不明白喷楼主的人

无意义的东西只会增加人的阅读量,当垃圾信息越来越多,你就会不耐烦,然后可能会忽略掉重要的东西

每个人的精力和时间都有限,不要产生垃圾信息,也不要让人阅读垃圾信息。
bnm965321
2020-08-24 09:41:22 +08:00
这种注释是多余的,绝不是有了比没有好,因为如果要修改代码也要去修改这些注释,就会带来多余的心智负担
kiroter
2020-08-24 09:47:08 +08:00
这是老年人刚入门吧, 还没习惯。习惯就好了。
shuigui
2020-08-24 09:59:10 +08:00
是不是什么基于人工智障的插件自动生成的?
ytll21
2020-08-24 09:59:52 +08:00
写出这样注释的程序员,毫无疑问,就是水平还停留在初级阶段,需要多读书,多看别人的代码来提高自己。可以参考这篇文章,对号入座。https://www.lovelywindy.club/2020/08/24/jie-du-java-by-comparison-become-a-java-craftsman-in-70-examples/
fx777
2020-08-24 10:11:31 +08:00
我们公司 代码里边 一堆人名。。
这些人名就是 各位产品经理的名字。。例如“2019 年 12 月 12 日 xx 产品说 这里要删掉 xxxx ”
securityCoding
2020-08-24 10:15:13 +08:00
@zengguibo 英文不是母语,经常词不达意的,代码即文档很难很难做到,Apache 的开源项目注释比源码还多呢
tiedan
2020-08-24 10:19:25 +08:00
注释是解释的是用图,不是代码的翻译。 要是代码里充满了,“声明了 xx 变量”,“这里循环 XX 次,然后取 XX 字段累和”,这种注释不如不写。
jasonding
2020-08-24 10:22:52 +08:00
有些人都不看注释,只管问。哪怕注释写的再清楚,甚至连数据库表映射模型都得挨个问,因为注释看不懂
azkaban
2020-08-24 10:26:48 +08:00
难道是按行算钱
goldenCold
2020-08-24 11:01:43 +08:00
以前接手过一个项目,写的变量名是 a;b;c 这种无意义的名字,然后有注释说明 a;b;c 是什么意思。后来有人接手写了 d;e;f,轮到我改的时候,发现注释已经和变量对应不上了。只能一行行的看代码猜变量意思
注释只是辅助作用,有最好。 主要还是代码一定要语义化,命名清晰
edk24
2020-08-24 11:04:31 +08:00
whitev2
2020-08-24 11:15:35 +08:00
@jiyingze #58 checkstyle 要求每个方法都要有注释,然后就用插件给每个方法生成注释,为了过检查而加的
RadishWind
2020-08-24 11:21:49 +08:00
我也碰到过,直接回怼这么写的同学一句:“有空这么写注释,不如把变量名写的名白点”

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

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

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

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

© 2021 V2EX