你喜欢注释丰富, Commit Message 详尽,还是反之?

7 月 4 日
 Had

作为一个大龄 Ops ,喜欢简洁的代码和注释,但是写起帖子又特别碎碎念(开头就有点跑题了

本人算是古法 Vibe Coding 了,基本上除了自己的一个重构小 skill 以外,也没有安装市面上流行的 skill 。 Claude Code 和 Codex 配合其最新模型,在近两个月我前者烧了 170 亿+后者烧了 200 多亿,近四百亿 token (当然缓存命中率在 95.5%+),所以默认是怎样我还是挺清楚的,简而言之就是,

Codex 注释很少,Commit Message 你若是不稍稍加点限定,可能就只有标题,body 都没有 Claude Code 狂写注释,一个 feature 做完你不做冗余注释清理,看起来就是废话连篇,而且 Commit Message 也写的特别长

WDL本体早期使用 Claude Code ,后来因为 Opus 4.7/4.8 确实没有 GPT5.5 强,就换了 Codex 至今,基本上 CC 早期的注释痕迹已经清理的差不多了,因为是主 Coder+多 Reviewer 的结构,做为 Reviewer 的 CC 并不存在看不懂 Codex 代码的问题,但是又常常会给一些 NIT 诸如再补点注释,或者这个变更要在 Commit Message 里面体现之类

而在写大的 dogfooding 的 demo ,也就是 WDL-CHAT ,基本上都是用 CC rush 出来的,CC 默认真的会是那种高频提交+海量注释的类型,现在的结果也是我做了几轮注释清理才得到的,哪怕是这样,就看具体的文件也能看到依然有大块大块的注释在里面

不知道诸位喜欢哪种风格?

5264 次点击
所在节点    程序员
31 条回复
Nasdaq
7 月 4 日
Claude behind me
jko123
7 月 4 日
“古法 vibe coding”,“两个月烧了 370 一 token”,这真的是古法吗😲
ronman
7 月 4 日
你这算古法?!
canyue7897
7 月 4 日
不看代码
不管注释
完成任务
省 token 省钱
就是我的目标
darksword21
7 月 4 日
直接用 emacs 的 commit message 规范
wiekern
7 月 4 日
我倾向于代码内注释,commit 消息相对简洁一些,当然要能说明提交的主要改动,不能为了精简而精简。如果你希望有 commit 消息来生成 changelog 文档,那在 commit body 里写详细一点也 OK 吧,还是要适合自己。你可以写规则让 AI 提交代码时遵守
Had
7 月 4 日
@jko123
@ronman
古法 vibe coding 指不用复杂的 skills:)
Had
7 月 4 日
@wiekern 写规则就不够古法了:)
不过 commit message 写全的意义也在于让 llm 根据提交进行阶段性总结时,不用去一个提交一个提交去 diff
ershierdu
7 月 4 日
95%的 Claude code 注释都是没必要的,太啰嗦了。

再进一步讲,注释是模型基于你的 prompt 生成的,那理论上另一个模型基于同样的 prompt 也能理解代码?所以真正有价值的是把人的输入保留下来,通过注释或文档
Had
7 月 4 日
@ershierdu 我觉得稍稍有点偏差 cc 是很主动写注释的,它和 user prompt 没啥关系?
另外其实代码都能理解 codex 写的 cc 也能理解 但是它就是建议你再补点注释或者解释性内容
好代码应该是自解释的
unused
7 月 4 日
注释也算 token 哦
shitshit666
7 月 4 日
我觉得代码自解释最重要,注释只写'为什么'而不是'是什么',commit message 简洁说明改动即可。
dwhh
7 月 4 日
@ronman 他说的是古法 vibe coding ,不是古法 coding 。。。
weiwenhao
7 月 4 日
我觉得注释太多是有点费 token 的,费 token 还好,但是浪费 context 是大问题,context 一大整体效果就会变差。
lucays
7 月 4 日
除了关键部分业务需求一行注释啥的
什么大段的函数注释类注释本来就没有用,骗骗自己得了,AI 出来了彻底没用了,浪费 token
defaw
7 月 4 日
Commit message 还是尽量详细一点比较好,因为对于 AI 来说,如果他不能从 commit message 里面拿到它的信息的话,它就只能制造非常多轮对话(工具调用)来寻找你所说的信息。这个不仅是消耗上下文,而且每一轮对话都会收每一轮对话的钱。
mogita
7 月 4 日
这是我的全局 CLAUDE.md 里关于代码注释的一条,加上之后注释再也不废话了。

- Comments document the contract a caller must respect, not the internal mechanism, downstream effects, or motivating examples.
mogita
7 月 4 日
咋发出去了。提交信息也可以类似的方式简单约束一下,不然全是小作文。
craftsmanship
7 月 4 日
@canyue7897 +1 请问目前的最佳实践是什么
clemente
7 月 4 日
写 changlog 就行

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

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

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

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

© 2021 V2EX