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

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

怎么让大家对于比较复杂的逻辑习惯写上注释
9941 次点击
所在节点    程序员
127 条回复
notejava
2020-10-23 09:05:28 +08:00
可读性强的代码就是最好的注释。如果代码本身就逻辑混乱,别指望他能写出好的注释。
zsyld
2020-10-23 09:05:38 +08:00
辣鸡代码才需要注释(狗头
djs
2020-10-23 09:07:54 +08:00
@labulaka521 悲伤
elintwenty
2020-10-23 09:09:53 +08:00
既然制定不了规范就不要管了,比起没有注释,过时的、失效的注释是更大的灾难。如果不能保证你的、甚至因你而出现的注释鲜明有效,那么还是完全没有更好。可以尝试要不要引入一些自动化的工具来建议主管去考虑
maddot
2020-10-23 09:11:36 +08:00
函数名称就是最好的注释
zsdroid
2020-10-23 09:12:07 +08:00
看了上面这么多楼的发言,感觉 jdk 特别垃圾,因为注释特别多。
4771314
2020-10-23 09:12:30 +08:00
基本的注释还是要有吧,不然谁看得懂?
代码是写给人看的,不是写给计算机看的。
labulaka521
2020-10-23 09:14:02 +08:00
@notejava 是的 但是还存在一些被重构 被迁移的字段 函数 几乎都没有注释 用了旧的函数 字段偶尔就会报错
idoggy
2020-10-23 09:14:31 +08:00
注释基本都是用来写 why 和 how 的,很少写 what 的,看事情不要二极管
alcoholpad
2020-10-23 09:16:19 +08:00
良好的函数名, 变量名 就是最好的注释, 函数尽量短小. 如果像写文章一样认真写代码, 根本不需要注释.
毕竟代码的修改会经常忘了同步注释, 更容易让人误解.
UmiKz
2020-10-23 09:18:34 +08:00
开发规范做到见名知其意,注释少些,也影响不大
watzds
2020-10-23 09:20:00 +08:00
这不是挺正常吗?
zjsxwc
2020-10-23 09:20:39 +08:00
除非复杂的业务逻辑我会先写注释后写代码做填空题,同时会引用产品经理具体需求描述的 issue id 方便后续跟进,还有这种复杂的业务由于不具备可复用性,我基本都是写在一个大方法里面。


大部分时候业务逻辑等价于 4 、5 个 sql 查询的就不写注释了,这种猜都能猜到是在干什么。
darktutu
2020-10-23 09:25:40 +08:00
我遇到过注释和代码不匹配的,更痛苦,还不如没有注释呢。
aydd2004
2020-10-23 09:30:29 +08:00
说真的 我给自己写的东西都加一堆注释

这些人哪里来的勇气
UsherOu
2020-10-23 09:30:55 +08:00
@labulaka521 代码即注释,见名知意
darkforest8848
2020-10-23 09:31:59 +08:00
@jerryrib 兄弟 bannner 能发下吗
zhangyangkam1
2020-10-23 09:34:50 +08:00
改变不了环境可以从自己做起
faceRollingKB
2020-10-23 09:36:36 +08:00
时间不够
JamesR
2020-10-23 09:45:47 +08:00
外包做的,时间不够嘛。

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

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

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

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

© 2021 V2EX