写注释也要解放

查看 112|回复 8
作者:LinkT   
不知道诸位公司有没有这样的要求,所有的代码改动都需要加注释。
比如这样:
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

yolee599   
个人觉得这种注释很丑陋,多此一举,在 commit 填写描述就行了。
LinkT
OP
  
@yolee599 是的,我也这么觉得,但是公司规定,没办法。
f1ush   
这要是重构改几十个文件的时候,不是看着人都麻了
LinkT
OP
  
@f1ush 是的,但是你说这种情况是小 case.
最恐怖的是注释外面套注释,我和我另一个同事戏称为:叠杀人书。 哈哈哈哈~
yan17   
公司这规定有点离谱啊,那要是后续再次修改,原来的注释要删除吗?
```
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   
人肉 git blame?
f1ush   
@LinkT 套注释?后续再修改真不删啊,那还需要 git 做什么啊哈哈哈
aver4vex   
见过。也写过。确实比较头大。
您需要登录后才可以回帖 登录 | 立即注册

返回顶部