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

2024 年 12 月 8 日
 drymonfidelia
7419 次点击
所在节点    程序员
45 条回复
dawangyezi
2024 年 12 月 8 日
对公的写详细一点。个人拥有的项目只写最关键的一些提示信息,别让自己忘了当时为啥这么做就行了
IvanLi127
2024 年 12 月 8 日
好记性不如烂笔头。commit message 是帮自己想起来之前到底抽什么风做了这些改动。不写的话我感觉都没必要用版本管理。
NoOneNoBody
2024 年 12 月 8 日
需求不变且认为当初写的已经是“最好”,就不需要

但需求往往会变,特别是增加功能
有个函数可以算 abcd 四个字段,初期对 c 没有需求,省算力求速度,c 可能就是以默认返回
当增加功能需求变化,c 也需要了,就记不起这个函数是如何处理 c 的了,会以为以前一并计算了

我最记不清的是数据类型
gouflv
2024 年 12 月 8 日
记录的目的,首先是给未来的自己看的。所以如果自己都觉得没有看的需求,那写了也白写
milzero
2024 年 12 月 8 日
@Remember 你还是太乐观,只需要一个月,甚至一周就会了
sharpy
2024 年 12 月 8 日
我现在用通义写 commit
realpg
2024 年 12 月 8 日
写 但是不会写的那么规范 过于简单的可以直接写 bugfix
出问题时候遍历历史容易找得到
我觉得需要复杂的写的时候 我甚至能写出长篇大论
自己一个人开发就是自己掌握详略得当,该糊弄时候糊弄,不该糊弄时候写流水账都不为
ixoy
2024 年 12 月 8 日
建议保持好 commit 习惯,可以多看看开源项目 commit ,他们都有统一的 commit 格式。
leo72638
2024 年 12 月 8 日
一个人可以随意一点,能写就写,有些没什么可写的就不写
iintothewind
2024 年 12 月 8 日
@leonshaw #15 写 CRUD 确实不需要注释,
但不是 CRUD 的代码却需要写太多注释才能让人看明白,

毫无疑问, 这就是烂代码.
iintothewind
2024 年 12 月 8 日
@passive #7 严格来说, 这是 code tricks, 代码的奇技淫巧.

没有冒犯的意思, 如果你以写这样的代码为荣, 我为你的 team member 感到遗憾.
akira
2024 年 12 月 8 日
经常写个代码, 过了一周就想不起来为啥这么写了。。好特么多奇奇怪怪的特例需求
rosu
2024 年 12 月 8 日
虽然是个人项目,但是也需要回顾和重写,就需要参考 commit message 了。规范可以考虑使用:Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0/

如果想用 AI ,同时也是 Jetbrain IDEs 用户,可以考虑使用我开发的 AICommit http://aicommit.app/

V 友通过 tg 、邮件联系我,获取半年激活码~
caola
2024 年 12 月 8 日
我自己的项目是 注释写,commit message 不写
xing7673
2024 年 12 月 8 日
注释不多写,commit 会写的比较详细
cutchop
2024 年 12 月 8 日
注释 AI 写、单测 AI 写、commit AI 写......代码 AI 写
passive
2024 年 12 月 8 日
@iintothewind 并不是 trick ,经过我和 team member 手里的代码里有许多这种“加了密”的函数,虽然精度要求会比这个例子高。

科学计算上为了运算速度,尤其是 1980 年前后的代码,受到当时硬件的限制,几乎到处都是这样对精确结果的近似展开,没有注释或者论文就没法维护,总不可能每次都从头推导。

全部 refactoring 成适合现代浮点硬件的“干净”代码需要的测试量太大,况且浮点结果的收敛和精确度有时候很玄学,工程上不现实,只能继续维护这些 legacy 代码,需要时在上面增加可选高阶修正项的补丁。
memorycancel
2024 年 12 月 8 日
RTFM

写文档写注释是 unix 留下来的传统之一,利己(方便自己复习),利他。
sampeng
2024 年 12 月 8 日
求求你们了。别再说好的代码不需要注释。这都是偷懒行为。到处都是 GetXXX 。猜都要猜半天。尤其是自己写的。你今天写这行函数方法和明天想同一件事可能命名就会不一样。歧义大得飞起。不写注释就是坑自己
hingle
2024 年 12 月 8 日
sing-box 也是个人维护的项目,基本不写注释,只写 commit 。

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

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

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

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

© 2021 V2EX