只有一人维护的项目一般需要写注释和 commit message 吗?好像没什么必要的样子,写了从来没看过

3 天前
 drymonfidelia
3715 次点击
所在节点    程序员
45 条回复
Remember
3 天前
不写注释不用说十年后了,就是一年后,你再看都很费劲。
passive
3 天前
有些地方不写注释,下个月你就不认识了
不管理好 commit ,写 changelog 或者 bisect 的时候很困扰
kk2syc
3 天前
三个月前自己反编译 app 写了一个开小区门禁的 http-api ,前几天 app 更新要重新适配参数了,代码打开发现一点印象都没有,以至于从头看一遍自己的屎山。
iintothewind
3 天前
好的代码,不需要太多注释,
但好的代码肯定有合理准确的命名方式。

合理准确的命名比注释强一百倍。

相反,如果一段代码,相同技术水平的人需要配合你写的大量注释才能看懂,
那你得好好反思一下,是不是你写的太烂了。
vcn8yjOogEL
3 天前
如果你认为那些代码永远都不会被更改, 可以不写
KimiArthur
3 天前
@iintothewind 注释应该是为了解释为什么的,而不是是什么。比如某段的参数设置很特别,不留下注释解释原因,碰到任何变动都可能需要花很长时间理解当初为什么这么处理
passive
3 天前
> 好的代码,不需要太多注释,

但是需要为了不到 10 行的代码写个 wikipedia 条目:

https://en.m.wikipedia.org/wiki/Fast_inverse_square_root

有些“程序员”日常编写和维护的都是这类代码。
orioleq
3 天前
注释不是特别有必要,变量名和方法名更重要,除非有些算法逻辑需要解释下,下次让你自己能快速看懂;
commit message 要,养成好的习惯。我觉得是这是类似每天早晚刷两次牙类似的习惯。当然你不愿意遵守也没啥大不了的。
spadger
3 天前
非常直观的业务逻辑代码没必要写注释,但是涉及到一些比较复杂的算法,几个常量,几个公式,实际代码呈现可能很简单,如果时间长了没有注释就容易看不懂。
xuanwu
3 天前
取决于提交历史信息对是否重要吧。
之前重现木兰时,每个提交都尽量实现一个粒度最小的语法功能点,而且悬赏任务有的就要参考某个特定 commit ,提交信息就很重要了。
soul11201
3 天前
1. 生命周期能活多久
2. 代码本身的易读性
3. 逻辑本身的复杂度

一般我都从这三个维度考虑
Abbeyok
3 天前
我是写给 copilot 看的,这样它能帮我自动补充一些代码,省时省力
nicaiwss
3 天前
现在没啥必要注释,ai 会自动生成
lemoon
3 天前
方便回滚就行
leonshaw
3 天前
@iintothewind 如果写的代码都不需要注释,得反思一下是不是 CRUD 写太多了。
z1645444
3 天前
注释帮助开发者加速恢复大脑里的上下文

变化比较多的、逻辑复杂的块,写上,是省未来迭代这部分开发者的时间
kakki
3 天前
让 AI 写,然后自己简单修改一下。
ksc010
3 天前
@KimiArthur 干什么 和 为什么我都有写
尤其是这个函数是干什么的
FrankAdler
3 天前
稍微复杂点的还是写吧,别哪天自己都看不懂了。
sir283
3 天前
还是要写一下,不然,就跟这个项目一样: https://github.com/MrsEWE44/J2ME-Loader ,我 fork 过来,项目里面没有一句注释,不得不根据 commit 重新捋一遍,然后再做一定的修改,使其更符合国人的操作习惯。

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

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

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

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

© 2021 V2EX