[不懂就问]想知道各位佬的注释习惯

作为一个编程小白,想请教一下各位佬,现在 vibe coding 时会让AI怎么写注释呢?
我目前都是让AI无论在什么语言中都是严格使用godoc的注释风格要求极其详细,会不会有啥副作用?

5 个赞

我也是一个编程小白,所以我有相当的觉悟:我不让ai写注释。

因为我是小白,我也看不懂代码,以后反正是其他ai看代码,ai看代码无所谓有没有注释。。

我是这么想的 :rofl:

至于注释,除了烧更多token,应该没啥副作用。

4 个赞

写一个项目结构的md,每次对话完更新md文档

那要看你的注释给谁看的,如果你不需要人去看这些注释,不写最好,写多了的副作用费token,除了注释本身增加 token 外,代码变动你还要 AI 把注释也一并修改吧。对于 AI 来说,代码就是最好的注释了。

1 个赞

除了废token 外,还有个负作用是可能会产生误导,一是注释不如代码精准,二是注释有维护成本,代码更新注释如果没有及时更新,误导性更大。

2 个赞

现在确实都很少自己写注释啊,甚至连git的提交我都要让他帮我提交一下,然后写好说明:joy:

该写还是写哈哈哈,除非搭了向量数据库。vibi情况下很容易出现屎山就是ai很多时候不知道之前写了什么,就会无限堆石。当然,能用就行的需求的话不写也可以的感觉

1 个赞

这样,不需要反复评审检验吗,,还是容易写bug

如果你问我怎么注释,我一般抄大厂规范,然后再加上一些比较难理解的代码上说明一下
AI 写注释?还是算了吧:smiling_face_with_tear: 就怕 AI 犯错犯幻觉,然后后继者还把注释当圣经:smiling_face_with_tear:

注释解决不了 AI 写屎山的问题,要解决屎山的问题还得有好的架构设计。

2 个赞

现在还要注释嘛,都是直接ai阅读理解了,起手就问,这代码干嘛的

1 个赞

这个其实还好,如果代码改了注释没改,一般让 AI Code Review 时 AI 都会指出的

写提交备注,这个是个大模型都能写的比较精确.

不推荐加任何注释,我是有一份或者多份文档维护和描述项目的,直接在代码文件加注释我感觉性价比不高而且会有各种方面的影响

布吉岛喔,对我来说还有点用,我习惯解耦,我也小白,原本也看不懂一点,但是写了注释方便我理解,我也会把注释当作代码内约束和规范提示词,所以我现在用ai工具基本没有什么全局提示词,而且现在写了很多工具很好扩展其他功能,如果是一个文件一个项目我真的会崩溃哈哈哈。

我一般 还是比较看重注释的,要不然过两个月我自己都不知道我写的是什么玩意,而且写好注释还有助于 github copilot 的自动完成。

当然注释写什么东西还是需要讲究的,写得过于琐碎也不是啥好事情,后续代码被改了,注释没被改的话还会带来很多后期维护的麻烦。

有些人喜欢一条注释都不写,搞什么「代码自注释」,这种我也不太喜欢,因为有些地方你怎么看代码都看不出来这是干什么的,为什么这么设计。

AI 第一次开始写的的话我没有要求他写任何注释. 只在 AI 写完我 /compress 了一遍我人工 review 代码我才让他写注释.