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

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

怎么让大家对于比较复杂的逻辑习惯写上注释
10282 次点击
所在节点    程序员
127 条回复
kajweb
2020-10-24 05:25:59 +08:00
@iwh718 给你看看我刚写的前端代码。
![垃圾代码.png]( https://i.loli.net/2020/10/24/CZ5m38crMqYEuyW.png)
看了之后是不是想吐。
虽然知道写的质量很差,但是不知道应该怎么改……
jatai
2020-10-24 08:50:18 +08:00
笑, 不写注释就是为新员工准备的, 如果每个新进小白刚来公司都能轻易替代老员工, 你让老板怎么想 🐶
qiumaoyuan
2020-10-24 22:14:50 +08:00
@b00tyhunt3r 嗯。你说的大神不需要团队合作,自然不需要别人看懂。需要团队合作的“大神”写的代码如果能让别人看不懂算哪门子大神?
少点 YY 吧。无非看了些别人炫技的代码就以为人家是大神了。然后抄着在项目里到处用,搞得整体系统无法维护很开心?
真的大神写的代码平淡无奇,每个人都觉得代码本来就是应该那么写的,但很可惜轮到自己写的时候,多数人写不出来平淡无奇的代码,这才是现实。
b00tyhunt3r
2020-10-24 23:39:53 +08:00
@qiumaoyuan
“需要团队合作的“大神”写的代码如果能让别人看不懂算哪门子大神?”

所以大神才写注释教你啊
qiumaoyuan
2020-10-24 23:53:34 +08:00
qiumaoyuan
2020-10-25 00:05:15 +08:00
@b00tyhunt3r 跟人对话之前先理解对方在说什么是起码的礼貌。
kwrush
2020-10-25 04:39:16 +08:00
我司也不写注释,之前的公司写的多一点。不过我觉得注释应该是解释为什么要这么写,实际情况下很少碰到需要解释代码的情况,大部分是因为 hack 或者 TODO 。描述代码干了什么的注释没有意义,除非逻辑复杂难懂,那应该考虑重构了

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

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

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

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

© 2021 V2EX