代碼審查規(guī)范

1、代碼審查規(guī)碼審查規(guī)范1.CodeReview目的目的CodeReview是一種用來確認方案設(shè)計和代碼實現(xiàn)的質(zhì)量保證機制，通過這個機制我們可以對代碼、測試過程和注釋進行檢查。CodeReview主要用來在軟件工程過程中改進代碼質(zhì)量，通過CodeReview可以達到如下目的：?在項目早期就能夠發(fā)現(xiàn)代碼中的BUG。?幫助初級開發(fā)人員學(xué)習(xí)高級開發(fā)人員的經(jīng)驗，達到知識共享。?避免開發(fā)人員犯一些很常見，很普通的錯誤。?保證項目組人員的良好溝通。?項

2、目或產(chǎn)品的代碼更容易維護。2.CodeReview的前提條件的前提條件代碼提交審核前，開發(fā)者必須確保代碼符合如下條件，審核者需要確保所有前提條件都已滿足方可開始審查，同時也是審查的主要檢查點。?所有代碼注釋清晰，語法正確，編譯通過。?日志代碼完整，業(yè)務(wù)日志、系統(tǒng)日志分開，中文描述，脫敏處理，狀態(tài)變更，全部清晰明確。?測試代碼覆蓋全部分支和流程，暫時統(tǒng)一使用工具Emma（各編譯器可下載對應(yīng)插件）進行CoverageCheck。?項目引用關(guān)

3、系明確，依賴關(guān)系清晰，配置文件描述。3.CodeReview的審查審查范圍代碼的一致性、編碼風格、代碼的安全問題、脫敏問題、代碼冗余、是否正確設(shè)計以符合設(shè)計要求（性能、功能）與設(shè)計文檔相同等等。?代碼是否采取措施避免運行時錯誤（如數(shù)組邊界溢出、被零除、值越界、堆棧溢出等）3.7、結(jié)構(gòu)性構(gòu)性檢查檢查（Structuredness）?程序的每個功能是否都作為一個可辯識的代碼塊存在?循環(huán)是否只有一個入口3.8、可追溯性可追溯性檢查檢查（Tra

4、ceability）?代碼是否對每個程序進行了唯一標識?是否有一個交叉引用的框架可以用來在代碼和開發(fā)文檔之間相互對應(yīng)?代碼是否包括一個修訂歷史記錄，記錄中對代碼的修改和原因都有記錄?是否所有的安全功能都有標識3.9、可理解性可理解性檢查檢查（Understability）?注釋是否足夠清晰的描述每個子程序?是否使用到不明確或不必要的復(fù)雜代碼，它們是否被清楚的注釋?使用一些統(tǒng)一的格式化技巧（如縮進、空白等）用來增強代碼的清晰度?是否在定義