代碼審查規(guī)范

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

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

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

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