代碼審查規(guī)范

代碼審查規(guī)范CodeReview目的CodeReview是一種用來確認(rèn)方案設(shè)計(jì)和代碼實(shí)現(xiàn)的質(zhì)量保證機(jī)制，通過這個(gè)機(jī)制我們可以對(duì)代碼、測(cè)試過程和注釋進(jìn)行檢查。CodeReview主要用來在軟件工程過程中改進(jìn)代碼質(zhì)量，通過CodeReview可以達(dá)到如下目的：在項(xiàng)目早期就能夠發(fā)現(xiàn)代碼中的BUG。幫助初級(jí)開發(fā)人員學(xué)習(xí)高級(jí)開發(fā)人員的經(jīng)驗(yàn)，達(dá)到知識(shí)共享。避免開發(fā)人員犯一些很常見，很普通的錯(cuò)誤。保證項(xiàng)目組人員的良好溝通。項(xiàng)目或產(chǎn)品的代碼更容易維護(hù)。CodeReview的前提條件代碼提交審核前，開發(fā)者必須確保代碼符合如下條件，審核者需要確保所有前提條件都已滿足方可開始審查，同時(shí)也是審查的主要檢查點(diǎn)。所有代碼注釋清晰，語法正確，編譯通過。日志代碼完整，業(yè)務(wù)日志、系統(tǒng)日志分開，中文描述，脫敏處理，狀態(tài)變更，全部清晰明確。測(cè)試代碼覆蓋全部分支和流程，暫時(shí)統(tǒng)一使用工具Emma（各編譯器可下載對(duì)應(yīng)插件）進(jìn)行CoverageCheck。項(xiàng)目引用關(guān)系明確，依賴關(guān)系清晰，配置文件描述。CodeReview的審查范圍代碼的一致性、編碼風(fēng)格、代碼的安全問題、脫敏問題、代碼冗余、是否正確設(shè)計(jì)以符合設(shè)計(jì)要求（性能、功能）與設(shè)計(jì)文檔相同等等。

3.1、完整性檢杳(Completeness)??代碼是否完全實(shí)現(xiàn)了設(shè)計(jì)文檔中所涉及的所有流程和功能點(diǎn)代碼是否已包含所有所需的業(yè)務(wù)日志、系統(tǒng)日志、異常日志，日志內(nèi)容是否完整，日志文件配置是否正確。??代碼是否使用緩存等，配置信息是否正確可配置。代碼中是否存在任何沒有定義或沒有引用到的變量、常數(shù)或數(shù)據(jù)類型等3.2、??致性檢杳(Consistency)代碼的邏輯是否符合設(shè)計(jì)文檔代碼中使用的格式、符號(hào)、結(jié)構(gòu)等風(fēng)格是否保持致3.3、????正確性檢杳(Correctness)代碼是否符合制定的標(biāo)準(zhǔn)所有的變量都被正確定義和使用所有的注釋都是準(zhǔn)確的所有的程序調(diào)用都使用了正確的參數(shù)個(gè)數(shù)3.4、?可修改性檢杳(Modifiability)代碼涉及到的常量是否易于修改(如使用配置、定義為類常量、使用專門的常量類等)代碼中是否包含了交叉說明或數(shù)據(jù)字典，以描述程序是如何對(duì)變量和常量進(jìn)行訪問的?代碼是否只有一個(gè)出口和一個(gè)入口(嚴(yán)重的異常處理除外)3.5、????可預(yù)測(cè)性檢杳(Predictability)代碼所用的開發(fā)語言是否具有定義良好的語法和語義是否代碼避免了依賴于開發(fā)語言缺省提供的功能代碼是否無意中陷入了死循環(huán)代碼是否避免了無窮遞歸3.6、健壯性檢杳(Robustness)代碼是否采取措施避免運(yùn)行時(shí)錯(cuò)誤(如數(shù)組邊界溢出、被零除、值越界、堆棧溢出等)3.7、結(jié)構(gòu)性檢查(Structuredness)??程序的每個(gè)功能是否都作為一個(gè)可辯識(shí)的代碼塊存在循環(huán)是否只有一個(gè)入口3.8、????可追溯性檢查(Traceability)代碼是否對(duì)每個(gè)程序進(jìn)行了唯一標(biāo)識(shí)是否有一個(gè)交叉引用的框架可以用來在代碼和開發(fā)文檔之間相互對(duì)應(yīng)代碼是否包括個(gè)修訂歷史記錄，記錄中對(duì)代碼的修改和原因都有記錄是否所有的安全功能都有標(biāo)識(shí)3.9、可理解性檢查(Understandability)注釋是否足夠清晰的描述每個(gè)子程序是否使用到不明確或不必要的復(fù)雜代碼，它們是否被清楚的注釋使用一些統(tǒng)一的格式化技巧(如縮進(jìn)、空白等)用來增強(qiáng)代碼的清晰度是否在定義命名規(guī)則時(shí)采用了便于記憶，反映類型等方法每個(gè)變量都定義了合法的取值范圍代碼中的算法是否符合開發(fā)文檔中描述的數(shù)學(xué)模型3.10、可驗(yàn)證性檢查(Verifiability)代碼中的實(shí)現(xiàn)技術(shù)是否便于測(cè)試測(cè)試代碼是否正確，是否覆蓋所有流程CodeReview的步驟目前CodeReview步驟暫定如下，試行一段時(shí)間再根據(jù)問題做調(diào)整。

代碼編寫者和代碼審核者坐在一起，由代碼編寫者按照設(shè)計(jì)文檔中的用例依次講解自己所寫的代碼和相關(guān)邏輯，可采用從前端到后臺(tái)的方式，例如從Web層-〉DAO層。代碼審核者在此過程中可以隨時(shí)提出自己的疑問，同時(shí)積極發(fā)現(xiàn)隱藏的bug；代碼編寫者和代碼審核者都要對(duì)這些bug記錄在案，代碼編寫者修改后再次提交審核，代碼審核者對(duì)應(yīng)bug記錄進(jìn)行回驗(yàn)。代碼講解完畢后，代碼審核者給自己安排幾個(gè)小時(shí)再對(duì)代碼審核一遍。代碼需要一行一行靜下心看。同時(shí)代碼又要全面的看，以確保代碼整體上設(shè)計(jì)優(yōu)良。代碼審核者根據(jù)審核的結(jié)果編寫代碼“審核結(jié)果”并將“審核記錄”和“審核結(jié)果”提交至GIT，審核記錄和審核結(jié)果參見附錄I審核記錄附錄II審核結(jié)果代碼編寫者GITpull并根據(jù)“審核結(jié)果”給出的修改意見，修改好代碼，有不清楚的地方可積極向代碼審核者提出。代碼編寫者bugfix等全部修改完成后提交代碼審核者再次進(jìn)行審核，通過審核則代碼審核者更新本次審查結(jié)果并提交至GIT，審核通過對(duì)代碼不能再進(jìn)行修改，任何已通過審核的代碼修改必須重新進(jìn)行審核流程。代碼審核者把CodeReview中發(fā)現(xiàn)的有價(jià)值的問題更新到代碼規(guī)范的文檔中，對(duì)于特別值得提醒的問題可群發(fā)email或QQ給所有技術(shù)人員。甲清代碼審核?-Ye甲清代碼審核?-YeCodeReview標(biāo)準(zhǔn)代碼審查的基礎(chǔ)是我們的設(shè)計(jì)文檔規(guī)范、代碼規(guī)范、日志規(guī)范、測(cè)試代碼規(guī)范，針對(duì)新增的業(yè)務(wù)場(chǎng)景和設(shè)計(jì)尚未有規(guī)范對(duì)應(yīng)時(shí)應(yīng)先確立規(guī)范然后再進(jìn)行代碼審核流程。CodeReview注意點(diǎn)經(jīng)常進(jìn)行CodeReview要Review的代碼越多，那么要重構(gòu)，重寫的代碼就會(huì)越多。而越不被代碼編寫者接受的建議也會(huì)越多，唾沫口水戰(zhàn)也會(huì)越多。建議每一個(gè)功能，每一個(gè)用例完成后都可以進(jìn)行審核，將大任務(wù)拆分為小任務(wù)進(jìn)行。程序員代碼寫得時(shí)候越長(zhǎng)，程序員就會(huì)在代碼中加入越來越多的個(gè)人的東西。越接近軟件發(fā)布的最終期限，代碼也就不能改得太多。CodeReview不要太正式，而且要短忘了那個(gè)代碼評(píng)審的Checklist吧，走到你的同事座位跟前，像請(qǐng)師父一樣請(qǐng)他坐到你的電腦面前，然后，花5分鐘給他講講你的代碼，給他另外一個(gè)5分鐘讓他給你的代碼提提意見，這比什么都好。而如果你用了一個(gè)Checklist，讓這個(gè)事情表現(xiàn)得很正式的話，下面兩件事中必有一件事會(huì)發(fā)生：只有在Checklist上存在的東西才會(huì)被Review。CodeReviews變成了一種禮節(jié)性的東西，你的同事會(huì)裝做很關(guān)心你的代碼，但其實(shí)他心里想著盡快地離開你。只有不正式的CodeReview才會(huì)讓你和評(píng)審者放輕松，人只有放松了，才會(huì)表現(xiàn)得很真實(shí)，很真誠(chéng)。記住Review只不過是一種形式，而只有在相互信任中通過相互的討論得到了有意義和有建設(shè)性的建議和意見，那才是最實(shí)在的。不然，作者和評(píng)審者的關(guān)系就會(huì)變成小偷和警察的關(guān)系。6.3.盡可能的讓不同的人Reivew你的代碼如果可能的話，不要總是只找一個(gè)人來Review你的代碼，不同的人有不同的思考方式,有不同的見解，所以，不同的人可以全面的從各個(gè)方面評(píng)論你的代碼。但不要太多了,人多嘴雜反而適得其反，基本上來說，不要超過3個(gè)人，這是因?yàn)?，這是一個(gè)可以圍在一起討論的最大人員尺寸。下面是幾個(gè)優(yōu)點(diǎn)：從不同的方向評(píng)審代碼總是好的。會(huì)有更多的人幫你在日后維護(hù)你的代碼。這也是一個(gè)增加團(tuán)隊(duì)凝聚力的方法。6.4.保持積極的正面的態(tài)度程序員最大的問題就是“自負(fù)”尤其當(dāng)我們Reivew別人的代碼的時(shí)候，我已經(jīng)見過無數(shù)的場(chǎng)面，程序員在CodeReview的時(shí)候，開始抨擊別人的代碼，質(zhì)疑別人的能力。太可笑了，我分析了一下，這類的程序員其實(shí)并沒有什么本事，因?yàn)樗麄冎肛?zé)對(duì)方的目的是想告訴大家自己有多么的牛，靠這種手段來表現(xiàn)自己的程序員，其實(shí)是就是傳說中所說的“半瓶水”。所以，無論是代碼編寫者，還是代碼審核者，都需要一種積極向上的正面的態(tài)度，編寫者需要能夠虛心接受別人的建議，因?yàn)閯e人的建議是為了讓你做得更好；審核者也需要以一種積極的正面的態(tài)度向編寫者提意見，因?yàn)槟鞘呛湍阍谝粋€(gè)戰(zhàn)壕里的戰(zhàn)友。記住，你不是一段代碼，你是一個(gè)人！6.5.學(xué)會(huì)享受CodeReivew這可能是最重要的一個(gè)提示了，如果你到了一個(gè)人人都喜歡CodeReivew的團(tuán)隊(duì)，那么，你會(huì)進(jìn)入到一個(gè)生機(jī)勃勃的地方，在那里，每個(gè)人都能寫出質(zhì)量非常好的代碼，在那里，你不需要經(jīng)理的管理，團(tuán)隊(duì)會(huì)自適應(yīng)一切變化，他們相互學(xué)習(xí)，相互幫助，不僅僅是寫出好的代碼，而且團(tuán)隊(duì)和其中的每個(gè)人都會(huì)自動(dòng)進(jìn)化，最關(guān)鍵的是，這個(gè)是一個(gè)團(tuán)隊(duì)。CodeReview操作目前我們將CodeReview分為兩個(gè)階段，開發(fā)互審和上級(jí)審查兩個(gè)階段。7.1開發(fā)互審任意兩名開發(fā)人員（建議不要固定配對(duì)，避免思維定勢(shì)）進(jìn)行交叉代碼審查，代碼編寫者準(zhǔn)備所開發(fā)的代碼相關(guān)的全部資料列表，包括需求、設(shè)計(jì)文檔、代碼工程、類、方法、配置文件、數(shù)據(jù)庫(kù)修改、數(shù)據(jù)修改等全部資料的版本號(hào)等詳細(xì)信息，向代碼審查者全面介紹代碼的目標(biāo)和設(shè)計(jì)實(shí)現(xiàn)。代碼審查者按照需求文檔、設(shè)計(jì)文檔、開發(fā)規(guī)范進(jìn)行代碼（業(yè)務(wù)、日志、測(cè)試）審查，代碼審查者將審查結(jié)果提交至GIT，出現(xiàn)的問題由代碼編寫者進(jìn)行修改并由代碼審查者復(fù)審，復(fù)審結(jié)果提交至GIT保留。代碼審查者對(duì)所審查的代碼負(fù)責(zé)。7.2上級(jí)檢查開發(fā)互審?fù)瓿珊?，由上?jí)進(jìn)行上級(jí)審查，流程與開發(fā)互審相同，對(duì)于三次復(fù)審仍未通過的代碼需要代碼編寫者組內(nèi)進(jìn)行檢討問題原因，并書面列出改進(jìn)計(jì)劃。7.3沖突解決當(dāng)開發(fā)互審時(shí)對(duì)于檢查內(nèi)容出現(xiàn)爭(zhēng)議時(shí)由上級(jí)進(jìn)行協(xié)調(diào)解決或逐級(jí)向上協(xié)調(diào)解決。當(dāng)上級(jí)審查時(shí)出現(xiàn)爭(zhēng)議時(shí)逐級(jí)向上協(xié)調(diào)解決。所有問題解決原則為公司利益、團(tuán)隊(duì)利益、業(yè)務(wù)需求、設(shè)計(jì)文檔、規(guī)范文檔等為參考標(biāo)準(zhǔn)。附錄I審核記錄審核記錄如同修改記錄一樣，直接記錄入代碼頭部，代碼審核者修改審核記錄后提交代碼至GIT參考即可。之后的審核可以基于兩次審核間的變更利用對(duì)比工具進(jìn)行增量審核?？蓞⒖既缦率纠悾簄gp_common/src/main/java/com/heepay/file/FileUtils.java代碼示例：王曉/***名稱：文件操作工具類**王曉/***名稱：文件操作工具類**創(chuàng)建者:*創(chuàng)建時(shí)間:2016-06-21*創(chuàng)建描述：實(shí)現(xiàn)文件的創(chuàng)建、刪除、復(fù)制、壓縮、解壓以及目錄的創(chuàng)建、刪除、復(fù)制、壓縮解壓等功能**修改者：李宗杰*修改時(shí)間：2016-08-08*修改描述：添加注釋和代碼審核信息*修改者:*修改時(shí)間:*修改描述:*審核者:侯建春*審核時(shí)間：201*修改者：李宗杰*修改時(shí)間：2016-08-08*修改描述：添加注釋和代碼審核信息*修改者:*修改時(shí)間:*修改描述:*審核者:侯建春*審核時(shí)間：2016-08-08*審核描述:格式可以一行寫不下再次一再來一行*審核者：李宗杰審核時(shí)間：2016-08-08*審核描述：審核不通過,log沒有使用log4j*審核者:*審核時(shí)間:*審核描述:*/附錄II審核結(jié)果審核結(jié)果建議以表格的形式描述，每個(gè)問題分別列出，可以通過標(biāo)注行號(hào)來具體指明位置，給出合理的修改意見并說明標(biāo)準(zhǔn)。為了方便記錄和查詢以及代碼編寫者修改和復(fù)審,建議審核結(jié)果寫入commitmessage中，由于commitmessage只能提交文本，我們以軟表格的形式描述。對(duì)于commitmessage的書寫規(guī)范，查看參考格式：docs（