VS2005中檢測和更正 C/C++ 程式碼缺陷

VS2005中提供的檢測方法:
1 IDE（整合開發環境）整合
2 #pragma 支援
3 批註支援
4 作為簽入策略的一部分執行分析工具
5 Team System 與 Team Build 的整合
6 命令列支援

一 程式碼分析工具用於檢測常見的編碼錯誤，例如緩衝區溢位、記憶體未初始化、空指標取消引用，以及記憶體和資源洩露。

為 C/C++ 程式碼啟用程式碼分析
在 Visual Studio 中開啟一個專案。

在“專案”選單上單擊“屬性”。

單擊“程式碼分析”。

在“啟用 C/C++ 程式碼分析”列表中，選擇“是(/analyze)”，然後單擊“確定”。

禁用 C/C++ 程式碼分析
在 Visual Studio 中開啟一個專案。

在“專案”選單上單擊“屬性”。

單擊“程式碼分析”。

在“啟用 C/C++ 程式碼分析”列表中，選擇“否”，然後單擊“確定”。

二 若要管理警告狀態，請在單獨的標頭檔案中列出所有程式碼分析警告。將標頭檔案包括在原始檔中。使用 warning pragma 重寫標頭檔案中的設定。

啟用或禁用程式碼分析警告
建立一個標頭檔案，其中列出所有程式碼分析警告和這些警告的初始狀態，如下面的程式碼所示：

// WarningState.h
   #pragma warning ( enable : 6001 )
   #pragma warning ( disable : 6011 )
// more warnings here
// end of file
將 WarningState.h 包括在應用程式標頭檔案中。在本例中，MyApplication.h 代表標頭檔案。

// MyApplication.h file
   #include "WarningState.h"
// ...
// end of file
將 MyApplication.h 檔案包括在原始碼檔案中。在本例中，MyApplication.cpp 代表原始檔。

// MyApplication.cpp file
#include "MyApplication.h"
若要修改警告狀態，請在 .cpp 檔案中使用 pragma 警告說明符，如下面的程式碼所示：

#pragma warning ( enable : 6011 )
#pragma warning ( disable : 6001 )    
三 若要在 C++ 中批註程式碼，必須首先包括 SourceAnnotations.h 檔案，然後使用 vc_attributes 名稱空間。(其他的批註屬性:http://msdn2.microsoft.com/zh-cn/library/ms182037(VS.80).aspx)
 在 C++ 中批註程式碼
 向專案標頭檔案新增 #include <CodeAnalysis/SourceAnnotations.h> 檔案。             
 然後，新增 using namespacevc_attributes; 語句。
 示例
 新增要包括的檔案和名稱空間後，批註 C++ 程式碼，如下面的程式碼所示：       
 // MyCode.h
#include <CodeAnalysis/SourceAnnotations.h>
using namespace vc_attributes;
class CMyClass
{
public:
       void f ( [Pre ( Valid = Yes )] int *pWidth );
// code ...
};

// MyCode.cpp
#include "MyCode.h"
void CMyClass::f ( [Pre (Valid = Yes)] int pWidth )
{
}
在 C 中，必須對列舉屬性值使用 SA_ 字首。在 C++ 中，SA_ 字首是可選的。

四 您可以在“錯誤列表”或輸出視窗中檢視程式碼分析警告。在“錯誤列表”中，可以對警告排序，並通過雙擊警告在程式碼編輯器中來檢視導致該警告的程式碼行。也可以選擇一個警告，然後按 F1 以檢視該警告的幫助資訊。
(C/C++ 程式碼分析警告:http://msdn2.microsoft.com/zh-cn/library/a5b9aa09(VS.80).aspx)
 
檢視程式碼分析警告     

在“檢視”選單上指向“其他視窗”，然後選擇“錯誤列表”。

五 本演練演示如何通過使用 C/C++ 程式碼分析工具來分析 C/C++ 程式碼以查詢潛在的程式碼缺陷。

演練：對 C/C++ 程式碼進行缺陷分析  (例項下載: http://msdn2.microsoft.com/zh-cn/library/ms182029(VS.80).aspx)

在本演練中，逐步完成使用程式碼分析來分析 C/C++ 程式碼以查詢潛在程式碼缺陷的過程。

您將完成下列步驟：

在本機節點上執行程式碼分析。

分析程式碼缺陷警告。

將警告視為錯誤。

批註原始碼以改進程式碼缺陷分析。

先決條件

Visual Studio 2005 Team System。

演示示例的副本。

對 C/C++ 進行基本瞭解。

對本機程式碼執行程式碼缺陷分析

在 Visual Studio 2005 Team System 中開啟演示解決方案。

演示解決方案現在將出現在解決方案資源管理器中。

在“生成”選單上單擊“重新生成解決方案”。

將生成解決方案，並且不出現任何警告或錯誤。

在解決方案資源管理器中，選擇 CodeDefects 專案。

在“專案”選單上單擊“屬性”。

將顯示“CodeDefects 屬性頁”對話方塊。

單擊“程式碼分析”。

從“啟用 C/C++ 程式碼分析”下拉選單中，選擇“是(/analyze)”，然後單擊“確定”。

重新生成 CodeDefects 專案。

程式碼分析警告顯示在輸出視窗中。

分析程式碼初始化缺陷警告

在“檢視”選單上單擊“錯誤列表”。

取決於您在 Visual Studio 2005 Team System 中選擇的開發人員配置檔案，您可能需要指向“檢視”選單上的“其他視窗”，然後單擊“錯誤列表”。

在“錯誤列表”中雙擊下列警告：

警告 C6230：語義不同的型別之間的隱式強制轉換: 在 Boolean 上下文中使用 HRESULT。

程式碼編輯器顯示導致在函式 boolProcessDomain() 中出現警告的程式碼行。該警告指示“if”語句中正在使用 HRESULT，而原本應使用布林值結果。

通過使用 SUCCEEDED 巨集來更正該警告。程式碼看起來應類似下面這樣：

if (SUCCEEDED (ReadUserAccount()) )
在“錯誤列表”中雙擊下列警告：

警告 C6282：運算子不正確: 在測試上下文中執行了常數賦值。Was == intended?（事實是否確實像預計的那樣？）

通過測試是否等同來更正該警告。程式碼看起來應類似下面這樣：

if ((len == ACCOUNT_DOMAIN_LEN) || (g_userAccount[len] != '//'))
將警告視為錯誤

在 Bug.cpp 檔案中，將下面的 #pragma 語句新增到檔案的開頭，將警告 C6001 視為錯誤：

#pragma warning (error: 6001)
重新生成 CodeDefects 專案。

在“錯誤列表”中，C6001 現在顯示為一個錯誤。

通過將 i 和 j 初始化為 0，更正“錯誤列表”中的其餘兩個 C6001 錯誤。

重新生成 CodeDefects 專案。

將生成專案，並且不出現任何警告或錯誤。

更正 annotation.c 中的原始碼批註警告

在解決方案資源管理器中，選擇 Annotations 專案。

在“專案”選單上單擊“屬性”。

將顯示“Annotations 屬性頁”對話方塊。

單擊“程式碼分析”。

從“啟用 C/C++ 程式碼分析”下拉選單中，選擇“是(/analyze)”，然後單擊“確定”。

重新生成 Annotations 專案。

在“錯誤列表”中雙擊下列警告：

警告 C6011：正在取消 NULL 指標“newNode”的引用。

該警告指示呼叫方檢查返回值失敗。在這種情況下，呼叫 AllocateNode 可能會返回一個 NULL 值（有關 AllocateNode 的函式宣告，請參見 annotations.h 標頭檔案）。

開啟 Annotation.c 檔案。

若要更正該警告，請使用“if”語句來測試返回值。程式碼看起來應類似下面這樣：

if (NULL != newNode)

{

newNode->data = value;

newNode->next = 0;

node->next = newNode;

}

重新生成 Annotations 專案。

將生成專案，並且不出現任何警告或錯誤。

使用原始碼批註

通過使用 Pre 和 Post 條件，批註函式 AddTail 的形參和返回值，如下面的示例所示：

[SA_Post (Null=SA_Maybe)] LinkedList* AddTail

(

[SA_Pre(Null=SA_Maybe)] LinkedList* node,

int value

)

重新生成 Annotations 專案。

在“錯誤列表”中雙擊下列警告：

警告 C6011：正在取消 NULL 指標“node”的引用。

該警告指示傳遞給函式的節點可能為空。

若要更正該警告，請使用“if”語句來測試返回值。程式碼看起來應類似下面這樣：

  . . .
  LinkedList *newNode = NULL;
  if (NULL == node)
  {
       return NULL;
      . . .
  }
重新生成 Annotations 專案。

將生成專案，並且不出現任何警告或錯誤。