诸位对“好的代码就是要注释比代码还多”这句话怎么看?

2022-05-30 09:45:29 +08:00
 nuanshen
14161 次点击
所在节点    程序员
155 条回复
Seayon
2022-05-30 21:05:16 +08:00
@qingshuang 感谢指导,这样好像是可以的,不过已经有 10 个索引了太多了 😂。
cp19890714
2022-05-30 21:16:08 +08:00
任何话术道理都有其对应的场景,不是万能的。
6167
2022-05-30 21:31:17 +08:00
我因为注释太多,被挂了机试
B1ankCat
2022-05-30 22:07:31 +08:00
矫枉必须过正,不过正不能矫枉
YYYeung
2022-05-31 02:05:32 +08:00
注释(这里不算方法签名上的那部分)应该是写某个模块的总体思路;或某个有惊喜的地方需要稍作注明,用于提示别人或以后的自己
而本来写在具体实现中的注释,应该通过好的变量名和方法名来体现;如果觉得其中的逻辑过于复杂,想写注释时,应该先思考一下逻辑是否可以进一步拆分
PureWhiteWu
2022-05-31 02:18:50 +08:00
别总把自己当高手,当牛逼的人,以为自己代码写得很漂亮,能自注释。
不信你试试回过头去看半年前你写的代码。

————————————————————

所以,多写点注释吧,把上下文说清楚,这不是留给后来人的,其实是帮助未来的你。
不写注释的研发,一看就知道没有过大型团队协作项目的经验。
drackzy
2022-05-31 02:33:55 +08:00
注释写的好,老板招个实习生,学会了你就被替代了。
pengtdyd
2022-05-31 05:47:58 +08:00
注释是写给高手看的,不是写给菜鸡看的,菜鸡就算你写了,他依旧不明白
lldld
2022-05-31 08:45:49 +08:00
@Seayon 你的需求为什么不用 payTime, id 两个来排序?
godloveplay
2022-05-31 08:47:22 +08:00
@brader #11 呃呃呃,诸如 注释撒谎 变量名撒谎 表名撒谎 扩展字段偷偷使用不加注释 太多太多了。
tairan2006
2022-05-31 08:48:00 +08:00
大部分情况下,这句说法是对的

其实注释最重要的是和代码保持一致,很多人更新了代码但是不更新注释
godloveplay
2022-05-31 08:50:31 +08:00
业务逻辑 /流程 注释 很重要

代码执行操作 很轻松能看明白的 不建议 注释
DiamondY
2022-05-31 08:50:47 +08:00
估计觉得这句话没问题的,都没看过流水账日记那样的代码注释吧?
54yinhang
2022-05-31 08:51:18 +08:00
过犹不及
yxzblue
2022-05-31 08:59:08 +08:00
谁说的?谁说的?
Seayon
2022-05-31 09:26:10 +08:00
@lldld 谢谢谢谢,我们考虑下加这个索引。前人这个做的,我想他考虑的是可能现有索引已经太多了( 10 个)所以不想加索引。
getinlight
2022-05-31 09:35:30 +08:00
只要是给时间,注释我都能写成作文。就怕既要又要还要。。。
cominghome
2022-05-31 11:51:21 +08:00
这句话后面代表的意思是对的,即,好的代码是要让人能看懂的,只盯着这句话就会显得太绝对
nuanshen
2022-05-31 12:04:40 +08:00
@getinlight 做业务的敏捷开发,实在没多少时间,业务还多变
w0017
2022-05-31 15:31:20 +08:00
代码写得结构清晰点,多迭代两次,尽量少用语法糖

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

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

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

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

© 2021 V2EX