写注释也要解放

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

• 请不要在回答技术问题时复制粘贴 AI 生成的内容

这是一个创建于 670 天前的主题，其中的信息可能已经有所发展或是发生改变。

不知道诸位公司有没有这样的要求，所有的代码改动都需要加注释。比如这样:

diff --git a/test.java b/test.java
index 70fd330..941c28d 100644
--- a/test.java
+++ b/test.java
@@ -1,5 +1,7 @@
 public class HelloWorld {
     public static void main(String[] args) {
-        System.out.println("World, Hello!");
+        //zhangsan modify this for xxxx. 2023-02-26 start
+        System.out.println("Hello, World!");
+        //zhangsan modify this for xxxx. 2023-02-26 end
     }
 }

一般这种注释都是最终代码验证 ok 上传时才加。如果代码的修改分散在很多不同的位置，那么加这个注释就很痛苦。

作为懒人，实在不想做这种麻烦事，于是写了个小脚本为添加到暂存区的修改添加注释：

使用方法

./icomment path "comment"

发出来给各位大佬看看还有没有可以改进的地方，请尽情批评。 https://github.com/LinkTTT/icomment

注释

test

Java

2023-02-26

22 条回复 • 2023-02-27 17:53:55 +08:00

yolee599

2023-02-26 22:15:24 +08:00 via Android

个人觉得这种注释很丑陋，多此一举，在 commit 填写描述就行了。

LinkT

2023-02-26 22:49:29 +08:00

@yolee599 是的，我也这么觉得，但是公司规定，没办法。

f1ush

2023-02-26 22:57:59 +08:00

这要是重构改几十个文件的时候，不是看着人都麻了

LinkT

2023-02-26 23:02:53 +08:00

@f1ush 是的，但是你说这种情况是小 case.
最恐怖的是注释外面套注释，我和我另一个同事戏称为：叠杀人书。哈哈哈哈～

yan17

2023-02-26 23:22:18 +08:00

公司这规定有点离谱啊，那要是后续再次修改，原来的注释要删除吗？
```
public static void main(String[] args) {
//zhangsan modify this for xxxx. 2023-02-26 start
+ //zhangsan modify this for xxxx. 2023-02-27 start
+ System.out.println("Bye, World! ");
+ //zhangsan modify this for xxxx. 2023-02-27 end
//zhangsan modify this for xxxx. 2023-02-26 end
}
}
```
不删不就变这样了？

jfcherng

2023-02-26 23:26:16 +08:00

人肉 git blame?

f1ush

2023-02-26 23:28:09 +08:00

@LinkT 套注释？后续再修改真不删啊，那还需要 git 做什么啊哈哈哈

aver4vex

2023-02-26 23:29:53 +08:00

见过。也写过。确实比较头大。

Pastsong

2023-02-27 00:11:28 +08:00

是你们公司没人会用 git blame ？还是你们不用 git

codingbody

2023-02-27 01:07:33 +08:00 via iPhone

你们公司是人工版本控制嚒

adoyle

2023-02-27 02:08:11 +08:00

喊你们的 CTO 来给大家解解惑。干嘛不用 git blame 或者 git log -S ，非要用这套蹩脚的注释。
如果一次提交只是删除代码是不是还得加上两行注释？多删改几次这文件不就满屏都是注释了？

如果不会用命令行操作，那我推荐 [git-history]( https://github.com/pomber/git-history)，网页浏览变更历史，能本地部署，也有 VS Code 插件。不香么？