SVN代碼提交注釋規范
為了規范代碼提交過程,也為了更准確的定位問題所在,現將SVN代碼提交的注釋內容進行規范,目的是為了讓每個人提交代碼都更清晰,更友好,更易閱讀。
規范如下:
每次提交代碼必須填寫代碼注釋
為了更清晰的定位,注釋使用三段式結構。
第一部分,標注提交代碼類型:是BUG,還是任務,還是其他需要緊急 處理的事項。
第二部分,標注禪道上,產生該BUG或任務的編碼。
第三部分,標注完成的這個BUG或是任務的名稱
具體舉例為:
BUG:2615: 打印數據
代碼注釋的作用是為了更准確定位問題所在,為了更快速的解決問題所 在,如果名稱不能更准確的表明代碼,或問題所在,或為了更准確的定位更 新代碼的問題所在,可以在注釋后部追加更准確的描述信息。
在代碼提交過程中,實際情況如果沒有任務或BUG編碼,代碼提交時, 需要咨詢相應的任務產生人員,尋求更准確的任務來源,或是派生出新的編 碼。
如果是解決問題中,發現的新問題或者是新需求提交代碼時,需要在后 部標注產生需求的任務或變更的來源人員名稱。
舉例如:
BUG:2615: 打印數據 :名字