如何为自某次提交后更改的所有文件添加注释？

Question

对于一个项目，我正在开发一个不属于我的代码库。我在第一次开始编辑代码时创建了一个新的git repo，并且可能用新代码触及了十几个文件，因此提交了许多提交。

我想要做的是在每个更改的顶部添加注释，说明我在那里更改了代码，仅用于录制目的。我想知道是否有人知道用git +脚本+魔法尘埃做一个简单的方法，或者如果我不得不手动完成它。我自己也想不出任何东西。

Answer 1

您已经拥有更改代码的记录。这就是你的git存储库的用途。当我查看其他人的源代码时，我发现看到这种评论很烦人。

Answer 2

您已经在存储库中记录了这些信息。重复这些信息会产生维护负担，并且倾斜的可能性会使源中的注释不可信。

假设某个提交的SHA-1是abc123，那么你运行

$ git diff --name-only abc123 HEAD

查看自那时以来发生过变化的所有文件。

如果您小心保持每个提交的范围有限，那么您可以返回日志并查看上下文中的更改，这更有用。要确定更改特定文件特定行的提交，请使用git blame，然后使用git show <SHA-1>。

要从不同的角度出发，请查看git log -p的输出以查看提交消息及其各自的增量。要查看引入或删除特定字符串的更改，请使用git log -S<string>进行pickaxe搜索。