时间戳

首页 > 解决方案 > 如何注释文件中的每个更改，以便它们对 git 可见但隐藏在实际文件中

git - 如何注释文件中的每个更改，以便它们对 git 可见但隐藏在实际文件中

问题描述

当我开发一个功能时，我通常需要更改不相关的文件：utils、helpers。但不仅如此。在某些情况下，某些存储库的事件与功能无关，但它只包含允许开发主要功能的附加代码。

最初我只是跳过了这个问题。但现在我明白了，如果某些文件与我提交的功能无关，我很难理解为什么要更改它们。我需要文件中的常见注释，但它们应该只对 git 可见：当我浏览提交消息/历史记录时，我想看看我为什么做了特定的更改。我不能评论每一个变化。最大的问题是我的更改可能不仅仅是添加代码行，而是删除。没有人需要看到缺席行的评论。

我的第一个想法是使用文件中的注释提交更改，然后再进行一次提交以删除注释。这就像一种解决方法。我在 PhpStorm 工作。我总是在那里看到 git 历史。我想从提交中打开一个文件，看看为什么我做了一些改变。我对我很有用。很有用。对我来说，它提供的收益与我从提交消息中获得的收益相同。

我没有看到其他解决方案。也许其他人有这样的问题。

我还假设其他 git GUI 程序可能具有这样的功能。

标签： gitphpstormatlassian-sourcetree

解决方案

那么，为什么不为此使用 git commit 消息呢？

-m您可以通过放置许多参数在提交消息中添加几行：

git commit -m "My commit message (headline)" -m "Second line" -m "third line..."

或者如果你不想这样写，你可以设置编辑器，当你运行时git commit，它会打开你的编辑器来写你的长提交信息，所以你可以解释你需要的一切，为什么你改变了文件等等上。

要设置编辑器，只需运行：

git config core.editor vim

PS：我建议查看人们如何在很棒的存储库中编写提交消息，例如 linux （https://github.com/torvalds/linux）。看看那里的信息是多么具有描述性并受到启发:)

推荐阅读