写注释也要解放

2023-02-26 21:41:29 +08:00
 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

3630 次点击
所在节点    程序员
22 条回复
simplereasy
2023-02-27 15:37:25 +08:00
大改动应该写
Goat121
2023-02-27 17:53:55 +08:00
你领导咋想的啊,这种代码看一眼都觉得烦,还怎么工作

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

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

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

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

© 2021 V2EX