2010-07-09 28 views
1

對於一個項目,我正在研究一個不屬於我的代碼庫。當我第一次開始編輯代碼時,我創建了一個新的git repo,並且可能觸及了十多個包含新代碼的文件,因爲提交了許多提交。如何添加註釋到自特定提交後更改的所有文件?

我想要做的就是在每個更改的頂部添加註釋,說明我在那裏更改了代碼,僅用於記錄目的。我想知道是否有人知道用git + scripts + magic dust做一個簡單的方法,或者如果我不得不手動去做。我想不起自己。

回答

2

您已將該信息記錄在您的存儲庫中。重複這些信息會造成維護負擔,並且歪斜的可能性會使源中的註釋不可信。

說出某些提交的SHA-1是ABC123,然後運行

$ git diff --name-only abc123 HEAD

看到所有自那時以來已更改的文件。

如果您小心保持每次提交的範圍有限,那麼您可以返回查看日誌並查看更有用的上下文更改。要識別改變特定文件的特定行的提交,請使用git blame,然後使用git show <SHA-1>

要從另一個角度出發,請查看git log -p的輸出以查看提交消息及其各自的增量。要查看引入或刪除特定字符串的更改,請使用git log -S<string>的鎬搜索。

2

您已經有記錄,您更改了代碼。這就是你的git存儲庫的用途。當我查看別人的源代碼時,我發現看到這種評論很煩人。

相關問題