軟件開發操做規範SOP

 

軟件開發操做規範SOP

 

版本	修訂內容
v0.0.1	[20160620]完成草稿.

 

 

• 1.源碼開發

使用到的工具,SVN,SourceInsight3.5,BeyondCompare.

 

• 2.善用工具

SourceInsight是很強大的代碼編輯和閱讀工具.可是標準版本是不支持UTF8字符編碼的,中文是使用ANSI編碼才顯示正常的. 幸虧咱們有一些插件幫忙. 我建議使用這些插件,從而支持UTF8編碼,可以在各類編輯器和編譯平臺完美顯示. SourceInsight還有一些可自定義的宏,極大提升編碼效率. 此外建議使用我提供的配置文件,主要是使用等寬字體以及關鍵字標註風格.

BeyondCompare是用於對比兩個目錄或者兩個文件的,它還能對比兩個壓縮包(tar,tgz,zip,rar),兩個文本(xml,txt,cpp等),兩個word或excel文檔,甚至於兩個圖片文件. 我建議修改其配置,

 

SecureCRT是用於遠程會話的工具,一般telnet到設備上會用到它,它比windows自帶的telnet客戶端好處多多. 能記錄日誌文件,可以搜索文本,很方便的回滾和複製粘貼,等等.建議使用我提供的SecureCRT工具包,和標準版本相比改變了默認配置,可自動記錄日誌文件.

  

• 3.準備工做

1.將SVN服務器上源碼導出(export)到PC上某個目錄,做爲編輯目錄.

使用SourceInsight導入編輯目錄中的源碼文件.好比,E:\project\temp\default-hi3518.

2.在編譯服務器或虛擬機上,建立一個同名的編譯目錄.

好比,Y:\project\temp\default-hi3518.

3.將SVN服務器上源碼檢出(checkout)到PC上某個目錄,做爲SVN操做目錄.

好比, E:\svn\temp\default-hi3518.

 

 

• 4.修改源碼的過程

1.經過SourceInsight查看和修改編輯目錄的源碼.

2.經過BeyondCompare將編輯目錄的源碼同步到編譯目錄. 此過程當中,能夠確認BeyondCompare中差別點是本次修改和要驗證的.

3.在編譯目錄,編譯源碼和驗證.

 

下圖顯示了編輯目錄和編譯目錄經過BeyondCompare的對比操做.

 

 

• 5.提交源碼的過程

1.在SVN操做目錄執行更新(update).

由於可能在我上次執行更新(update)後有其餘人提交了修改,我必須更新這些修改,不然直接提交個人源碼,可能會覆蓋其餘人的修改.

2.經過BeyondCompare將編譯目錄與SVN操做目錄進行同步和合並.

此過程當中,查看BeyondCompare中的差別點,確認是本次將要提交的修改,要同步到SVN操做目錄,或者是SVN操做目錄中更新到的其餘人的修改,要同步到個人編譯目錄中.

3.若是合入了其餘人的修改,就須要在編譯目錄,再次編譯源碼和驗證.驗證完畢後,將編譯目錄的修改同步到編輯目錄. 此過程當中,確認這些差別點都是其餘人提交的修改.

4.在SVN操做目錄執行提交(commit).[Notes1:提交前還有些事情要作,請看下文]

 

下圖顯示了編譯目錄和SVN操做目錄經過BeyondCompare的對比操做.

 

 

• 6.DeWarning

程序要完成功能,還要乾的漂亮.編譯中出現的每一個warning都要找到並消除.雖然大部分warning都無害,但有些可能會致命,可能致使難以復現和查找的死機問題. 消除每個隱患,從消滅warning開始.

將要提交的修改,須要作dewarning處理,確保不會引入新的warning.

 

• 7.代碼檢視

在向SVN提交修改前,除了要作自測試和dewarning,還須要請其餘同事幫助檢查修改的代碼.這稱之爲代碼檢視.

必須完成自測試以後,才能進行代碼檢視.

代碼檢視的目的,一是檢查修改是否能解決現有問題,是否會引入新問題.二是檢查所作的修改是否符合你們約定的代碼規範. 代碼提交以後,代碼就是全部人的,」不合羣」的代碼不受歡迎.

 

代碼檢視以前,要準備好修改先後的兩份代碼,經過BeyondCompare展現出每一個修改點.而後邀請其餘同事一塊兒檢查代碼.

代碼檢視過程當中,應該讓別人明白我這次修改的目的,個人實現思路,以及每一個修改點的意義.若是對源碼註釋不夠,代碼風格不符合約定標準,也會讓人難以明白.

代碼檢視一般會作的,檢查代碼規範和註釋,檢查有沒有資源泄漏(內存沒釋放,句柄沒關閉等等),檢查條件分支是否完整無遺漏,檢查邊界條件是否合適,是否有冗餘的代碼.其餘各類挑剔.

 

作代碼檢視時若是被別人發現有明顯缺陷,對程序員來講多少有點丟臉,這是正常的. 若是沒有這樣的壓力,可能就沒有那種動力去作得完美. 若是我修改代碼的時候,知道明天每行修改都會被別人圍觀,那今天我就儘可能作得完美點.不然,我也能夠糊弄一下,程序能在實驗室環境下測試過就無論代碼會不會變質腐敗. 若是擺好心態,把代碼當成你們的做品,不讓咱們的做品出現人爲不慎致使的瑕疵. 檢視代碼就是一塊兒圍觀,不由於檢查到別人代碼的缺陷而認爲本身更高明,也不由於被別人檢查到本身代碼的缺陷而感受被嘲笑.

 

問題單處理