軟件代碼審查報告_第1頁
軟件代碼審查報告_第2頁
全文預覽已結束

下載本文檔

版權說明：本文檔由用戶提供并上傳，收益歸屬內容提供方，若內容存在侵權，請進行舉報或認領

文檔簡介

1、精選優質文檔-傾情為你奉上精選優質文檔-傾情為你奉上專心-專注-專業專心-專注-專業精選優質文檔-傾情為你奉上專心-專注-專業軟件代碼審查報告檢查人：檢查日期：審查內容：審查總結果：說明：審查類型序號條款與說明審查結果一、注釋1源代碼有效注釋量必須達到20%以上2程序文件頭部應進行注釋，務必列出：版權說明、版本號、生成日期、作者、模塊目的/功能、主要函數及其功能、修改日志等。3有頭文件沒有源文件的要說明4函數頭部應進行注釋，列出：函數的目的/功能、輸入參數、輸出參數、返回值、調用關系等。5編寫代碼邊注釋6注釋的內容要清楚、明了，含義明確，防止注釋二義性7避免在注釋中使用縮寫，特別是非常用縮寫8

2、注釋應與其描述的代碼相近，對代碼的注釋應放在其上方或右方相鄰位置。9數據結構申明(包括數組、結構、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。10全局變量要有交詳細的注釋，包括對其功能、取值范圍。11對于switch語句下的case語句，如果因為特殊情況需要處理完一個case后進入下一個case處理，必須在該case語句處理完、下一個case語句前加上明確的注釋。二、標識符命名1標識符的命名要清晰、明了，有明確含義，同時使用完整的單詞或大家基本可以理解的縮寫，避免使人產生誤解。2命名中若使用特殊約定或縮寫，則要有注釋說明。3自己特有的命名風格，要自始至終保持一致，不可來回變化。4對于變量命名，禁止取單個字符（如i、j、k.），建議除了要有具體含義外，還能表明其變量類型、數據類型等，但i、j、k作局部循環變量是允許的。5命名規范必須與所使用的系統風格保持一致，并在同一項目中統一，比如采用UNIX的全小寫加下劃線的風格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式。三、可讀性1注意運算符的優先級，并用括號明確表達式的操作順序，避免使用默認優先級2避免使用不易理解的數字，用有意義的標識來替代。

溫馨提示

  • 1. 本站所有資源如無特殊說明，都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等，如果需要附件，請聯系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙，網頁內容里面會有圖紙預覽，若沒有圖紙預覽就沒有圖紙。
  • 4. 未經權益所有人同意不得將文件中的內容挪作商業或盈利用途。
  • 5. 人人文庫網僅提供信息存儲空間，僅對用戶上傳內容的表現方式做保護處理，對用戶上傳分享的文檔內容本身不做任何修改或編輯，并不能對任何下載內容負責。
  • 6. 下載文件中如有侵權或不適當內容，請與我們聯系，我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論