团队开发代码不爱写注释,如何解决这一困境?

2020-10-22 23:19:40 +08:00
 labulaka521
刚入职不久,维护的心累,在别人的没有注释代码上加功能是真的难受

怎么让大家对于比较复杂的逻辑习惯写上注释
10282 次点击
所在节点    程序员
127 条回复
sdushn
2020-10-23 11:16:39 +08:00
做 cr 啊,看不懂的,格式不对的都不让合入,
djyde
2020-10-23 11:34:48 +08:00
注释不是用来解释这段代码在做什么,而是告诉后来的人为什么要写这段代码。
paoqi2048
2020-10-23 11:35:24 +08:00
楼上一堆洗的,希望你们以后的同事都不写注释哈
haha512
2020-10-23 11:46:29 +08:00
看了上面回答,应该把第一个设计代码要加注释的人拉出来痛打一顿。
v2 任何一个问题下面, 总少不了一堆的“逼王之王”,为什么呢
pangleon
2020-10-23 12:01:11 +08:00
让 AB 互相改他们之前做的大需求,然后看他们对喷
labulaka521
2020-10-23 12:09:01 +08:00
@haha512 没办法 总有人觉得我的代码很优雅 很优雅 不用注释 结果一看 是什么玩意 叠加五六层 ifelse 真逼王之王
lululau
2020-10-23 12:16:45 +08:00
业务代码不需要注释,类名和方法名就是注释,把 PRD 写写好是最重要的
opengps
2020-10-23 12:26:28 +08:00
写注释奖钱啊,很多人不写,不就是因为大部分企业都卸磨杀驴吗
wysnylc
2020-10-23 12:29:54 +08:00
@labulaka521 #86 你要保持这个心态,永远不要觉得自己优雅
优雅是别人对你的评价,不是自己觉得自己多牛逼,总有些人觉得自己写点代码就人上人了莫名其妙的优越感
不写注释的都是垃圾
Leigg
2020-10-23 12:36:21 +08:00
楼上一帮人,个个以为光看代码就看懂了,要么是真牛逼,没遇到过垃圾同事,要么是长期混迹小公司自己就从来不写注释的,别人问还怼别人的。
哪个比例更高一点?
Huelse
2020-10-23 13:06:51 +08:00
当然是能一起商量好最好

实在不行就你写的时候完全不按套路命名来写即可,注释留在自己的仓库,commit 的时候去掉注释
zerofancy
2020-10-23 13:16:52 +08:00
lint
tony1890
2020-10-23 13:21:48 +08:00
没办法。只能管好自己。虽然我跟同事说过多次,不用的代码要么注释要么删除,方法最起码说明是干嘛的,公共方法还要写入参和 returns,公共组件要写文档。balabala 一堆。
然而他们很难做到。唯一欣慰的就是提交写简短记录了。
newmlp
2020-10-23 13:26:18 +08:00
又不是不能用
darktutu
2020-10-23 13:28:44 +08:00
@Still4 是啊,所以我挺好奇的,一般项目的注释都很完善,只有我遇到的是乱糟糟的?还有就是单元测试,也是没多少或者没有,到那时看评论,大家经常都是齐备的,我也搞不明白。
tabris17
2020-10-23 13:29:03 +08:00
我只在个人项目里会尽责地写注释
troywinter
2020-10-23 13:51:32 +08:00
题外话,注释和代码有不同的目的,不存在好的代码不需要写注释的,他们的目的本来就不相同,有些简单的逻辑确实不需要注释,但大多数情况下,注释还是应该解释下这样设计的原因和用法,最好链接到设计文档。
qiumaoyuan
2020-10-23 14:01:04 +08:00
@labulaka521 也许你见过你口里描述的人,但同时你要知道这世界上真有不少人的代码是不用注释的。把无法理解的事情打个装逼的标签,把难以实现的理想当作自己不努力的借口对自己没有好处。有理就好好讲理这是程序员的基本素养,起码冰冷的机器不会照顾你的个人情绪。
tankren
2020-10-23 14:19:03 +08:00
看可读性吧
lazydog
2020-10-23 14:24:19 +08:00
不写注释看来是真的不行,我一周前的代码,今天看的时候竟然看不懂了,费了好长时间才反推回去。

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

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

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

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

© 2021 V2EX