comment是版本管理中非常重要的內容,尤其是在經年累月的大型項目中,鐵打的項目,流水的SE,哪怕只言片語的留下,對后來者問題的對應很多時候都能起到重要作用,這篇文章用來講解git中如何進行comment的管理.

為什么需要comment

為什么需要comment，理由有很多：規范，可讀，可維護，bug分析等等。很多人可能在新入一個大型項目時候進行原因調查時候都有很多障礙，尤其是業務不清晰，然后再加上經年累月的bug修改，導致目前的代碼已經面目全非的可能性很多，如果有點comment，那就是絕望之中的一根稻草，自然十分重要。
以前曾經碰到過一個很有趣的case，邏輯判斷的＝＝被寫成了＝，這樣就變成恒真的一個判斷了，跟刪除無異，本來準備修改，無意之中發現此行是刻意被修改的，而且提交了一行comment，內容大概是＂bug fix＂,這么難解的comment雖然讓人望而卻步，但是總提供了一點信息：這是不可以隨便修改的，要么把此行刪除，要么別動它。

comment使用實踐

好記性不如爛筆頭，大型項目中comment最好要跟redmine／trac／bugzero等工具結合起來，不同的項目一般都有自己的規范，比如：

項目說明

原則1	提供ｂｕｇ追蹤工具中此次修改的詳細信息的Ｔｉｃｋｅｔ號，以確認更詳細信息
原則2	同時將簡單將修改原因的重點信息列出，便于確認
原則3	盡量１行之內，便于整體確認

以下將通過實際的例子操作來展示如何進行comment的管理。

當前狀態

使用上篇文章創建的分支，因為其中已經有若干commit附帶若干comment

[root@ku8-1 demoprj]# git branch * fea-restapimaster [root@ku8-1 demoprj]# git log --oneline 6e990e6 create another rest api list 57c2f6a create rest api list bc390f0 Another new files in Master c2ce58b New file added in Master 23c9620 Merge branch 'develop' 4b76d48 for branch 70dfd04 initial [root@ku8-1 demoprj]#

comment管理

其實這仍然是rebase命令的延續，使用rebase -i HEAD~ｎ就可以將最近修改的ｃｏｍｍｅｎｔ選中進行管理。

操作說明

目前這方面的操作仍然不是很人性化，進入到編輯器之后可以引發的執行子命令有如下六條

項目說明

pick	用于顯示選中，不做任何修改；
reword	僅僅用于修改提交注釋信息；
edit	修改提交的文件，做增補提交；
squash	將該條提交合并到上一條提交，提交注釋也一并合并；
fixup	將該條提交合并到上一條提交，廢棄該條提交的注釋；
exec	執行一條命令

reword操作

reword操作用于修改以前不合適的注視太合適不過了，比如我們將＂create another rest api list＂的注釋修改為：”T10100: create another rest api list: person/list”, 將bug追蹤工具的Ticket號與之進行結合，并能從comment中看出大體信息。

修改對象行前的命令

將欲修改的所在行的pick改為reword，表明要對此行進行comment的修正動作

保存退出后進入另外一個編輯界面，在此界面中可以真正的修改想要修改的注釋：

保存退出

[root@ku8-1 demoprj]# git rebase -i HEAD~2 [detached HEAD 4ffee47] T10100:create another rest api list: person/list1 file changed, 1 insertion(+)create mode 100644 restapi-list-2 Successfully rebased and updated refs/heads/fea-restapi. [root@ku8-1 demoprj]#

push操作

[root@ku8-1 demoprj]# git push origin fea-restapi -f Counting objects: 7, done. Compressing objects: 100% (4/4), done. Writing objects: 100% (6/6), 641 bytes | 0 bytes/s, done. Total 6 (delta 1), reused 0 (delta 0) remote: remote: Create merge request for fea-restapi: remote: http://e5091e18d568/root/demoprj/merge_requests/new?merge_request%5Bsource_branch%5D=fea-restapi remote: To git@172.17.0.2:root/demoprj.git+ 6e990e6...4ffee47 fea-restapi -> fea-restapi (forced update) [root@ku8-1 demoprj]#

結果確認

在gitlab上可以看到comment已然改變

總結

這篇文章介紹了如何在git中進行comment的管理，comment對于項目也恰似那不可或缺的一塊小小的拼圖，在軟件開發日益進步的今天，細節的完善和掌控已經是越來越重要。

總結

以上是生活随笔為你收集整理的版本管理之gitlab实践教程：基础篇(3)的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。