1. 程式人生 > >SVN版本管理,提交程式碼規範

SVN版本管理,提交程式碼規範

專案開發要求:

1、工作目錄要及時更新,不要和SVN伺服器有太大的差別

2、提交程式碼時,如果出現衝突,必須仔細分析解決,不可以強行提交

3、提交程式碼之前先在本地進行測試,確保專案能編譯通過,且能夠正常執行,不可盲目提交

4、必須保證SVN上的版本是正確的,專案有錯誤時,不要進行提交

SVN注意事項,請嚴格按照操作順序操作,避擴音交程式碼導致重大事故:

一.提交之前先更新

1.SVN更新的原則是要隨時更新,隨時提交。當完成了一個小功能,能夠通過編譯並且自己 測試 之後,謹慎地提交。

2.如果在修改的期間別人也更改了svn的對應檔案,那麼commit就可能會失敗。如果別人和自己更改的是同一個檔案,那麼

update時會自動進行合併,如果修改的是同一行,那麼合併時會產生衝突,這種情況就需要同之前的開發人員聯絡,兩個人一起協商解決衝突,解決衝突之後,需要兩人一起測試保證解決衝突 之後,程式不會影響其他功能。

3.在更新時注意所更新檔案的列表,如果提交過程中產生了更新,則也是需要重新編譯並且完成自己的一些必要測試,再進行提交。這樣既能瞭解別人修改了哪些檔案,同時也能避免SVN合併錯誤導致程式碼有錯

二.保持原子性的提交

每次提交的間歇儘可能地短,以幾個小時的開發工作為宜。例如在更改UI介面的時候,可以每完成一個UI介面的修改或者設計,就提交一次。在開發功能模組的時候,可以每完成一個小細節功能的測試,就提交一次,在修改

bug的時候,每修改掉一個bug並且確認修改了這個bug,也就提交一次。我們提倡多提交,也就能多為程式碼新增上保險。

三.提交時注意不要提交本地自動生成的檔案

一般配置管理員都會將專案中一些自動生成的檔案或者與本地配置環境有關的檔案遮蔽提交(例如eclipse中的.classpath檔案等)。如果專案中沒有進行這方面的配置來強行禁止提交這樣的檔案,請自覺不要提交這樣的檔案。提交了這樣的檔案後,別人在更新後就可能與本地的環境衝突從而影響大家的工作。

四.不要提交不能通過編譯的程式碼

程式碼在提交之前,首先要確認自己能夠在本地編譯。如果在程式碼中使用了第三方類庫,要考慮到專案組成員中有些成員可能沒有安裝相應的第三方類庫。專案經理在準備專案工作區域的時候,需要考慮到這樣的情況,確保開發小組成員在簽出程式碼之後能夠在統一的環境中進行編譯。

五.不要提交自己不明白的程式碼

程式碼在提交入SVN之後,你的程式碼將被專案成員所分享。如果提交了你不明白的程式碼,你看不懂,別人也看不懂,如果在以後出現了問題將會成為專案質量的隱患。因此在引入任何第三方程式碼之前,確保你對這個程式碼有一個很清晰的瞭解。

六.提前協調好專案組成員的工作計劃

專案經理應該合理分配工作計劃。每個成員在準備開始進行某項功能的修改之前,如果有可能,先跟工作小組的成員談談自己的修改計劃,讓大家都能瞭解你的思想,瞭解你即將對軟體作出的修改,這樣能儘可能的減少在開發過程中可能出現的衝突,提高開發效率。同時你也能夠在和成員的交流中發現自己之前設計的不足,完善你的設計。

七.對提交的資訊採用明晰的標註(寫註釋)

在一個專案組中使用SVN,如果提交空的標註或者不確切的標註將會讓專案組中其他的成員感到很無奈,專案經理無法很清晰的掌握工作進度,無法清晰的把握此次提交的概要資訊。在發現錯誤後也無法準確的定位引起錯誤的檔案。所以,在提交工作時,要填寫明晰的標註,能夠概要的描述所提交檔案的資訊,讓專案組其他成員在看到標註後不用詳細看程式碼就能瞭解你所做的修改。

八.慎用鎖定功能

在專案中要慎用鎖定的功能,在你鎖定了一個檔案之後別人就無法繼續修改提交該檔案,雖然可以減少衝突的發生率,但是可能會影響專案組中其他人員的工作。平時只有在編輯那些無法合併的檔案(例如圖片檔案,flash檔案等)時,才適當的採用鎖定操作。