用法警告
更新：2010 年 8 月
用法警告會支援 .NET Framework 的正確用法。
在本節中
規則 |
說明 |
|---|---|
方法簽章包括不用於方法主體中的參數； |
|
已建立但從未使用新物件、已呼叫會建立並傳回新字串的方法，而新字串從未使用過，或者 COM 或 P/Invoke 方法傳回從未使用的 HRESULT 或錯誤碼。 |
|
屬於 Dispose 實作的方法不會呼叫 GC.SuppressFinalize，或不屬於 Dispose 實作的方法會呼叫 GC.SuppressFinalize，或呼叫 GC.SuppressFinalize 並傳遞非 this (在 Visual Basic 中為 Me) 的方法。 |
|
例外狀況遭到重新擲回，而且已在 throw 陳述式中明確指定此例外狀況。 如果例外狀況是透過在陳述式中指定例外狀況而重新擲回，則會遺失在擲回例外狀況之原始方法和目前方法之間呼叫的方法清單。 |
|
這將使原始錯誤變得難以偵測及偵錯。 |
|
方法實作包含程式碼路徑，可在相同物件上造成多個 System.IDisposable.Dispose 呼叫或 Dispose 對等用法 (例如，部分型別上的 Close() 方法)。 |
|
方法主體中的常值 (Literal) 字串包含一個或多個 Microsoft 拼字檢查程式庫無法辨識的字。 |
|
已定義平台叫用方法，而且 .NET Framework Class Library 中有具同等功能的方法存在。 |
|
實值型別會宣告明確的靜態建構函式。 若要修正此規則的違規情形，請在宣告所有靜態資料時將靜態資料初始化，並移除靜態建構函式。 |
|
對例外狀況型別為 (或衍生自) ArgumentException 的預設 (無參數) 建構函式進行呼叫，或將錯誤的字串引數傳遞至例外狀況型別為 (或衍生自) ArgumentException 的參數化建構函式。 |
|
既非常數，亦非唯讀的靜態欄位不是安全執行緒。 必須小心控制對這類欄位的存取，而且需要進階的程式設計技巧同步 (Synchronize) 對類別物件的存取。 |
|
型別中繼承自 System.EnterpriseServices.ServicedComponent 的方法是以 System.Web.Services.WebMethodAttribute 標示。 因為 WebMethodAttribute 和 ServicedComponent 方法具有衝突的內容和交易流程的行為及需求，所以方法的行為在某些情節中會是不正確的。 |
|
實作 System.IDisposable 的型別宣告了也實作 IDisposable 之型別的欄位。 宣告型別的 Dispose 方法不會呼叫欄位的 Dispose 方法。 |
|
當建構函式呼叫虛擬方法時，有可能尚未執行叫用此方法之執行個體的建構函式。 |
|
如果型別會繼承自可處置的型別，則必須從本身的 Dispose 方法呼叫基底型別的 Dispose 方法。 |
|
實作 System.IDisposable 且具有建議 Unmanaged 資源用法之欄位的型別，未實作如 Object.Finalize 所述的完成項。 |
|
從外部可見的列舉會以 FlagsAttribute 標記，並且有一個或多個不是二的次方，或組合列舉上其他定義值之次方的值。 |
|
GetHashCode 會依據目前執行個體傳回值，適用於雜湊演算法和資料結構，如雜湊資料表。 兩個型別相同且相等的物件必須傳回相同的雜湊程式碼。 |
|
在 finally 或 fault 子句中引發例外狀況時，新的例外狀況會隱藏作用中的例外狀況。 在 filter 子句中引發例外狀況時，執行階段會以無訊息模式攔截例外狀況。 這將使原始錯誤變得難以偵測及偵錯。 |
|
最終化必須透過繼承階層架構 (Inheritance Hierarchy) 進行傳播。 若要確保這一點，則型別必須在它們自己的 Finalize 方法中呼叫基底類別 Finalize 方法。 |
|
完成項必須使用系列存取修飾詞 (Modifier)。 |
|
您不得變更繼承成員的存取修飾詞 (Modifier)。 將繼承成員變更為私用不會防止呼叫端存取方法的基底類別 (Base Class) 實作。 |
|
雖然 Common Language Runtime 允許使用傳回型別區分其他部分都相同的成員，但這個功能不屬於 Common Language Specification，也不是 .NET 程式語言共通的功能。 |
|
public 型別會實作等號比較運算子，但不會覆寫 Object.Equals。 |
|
偵測到運算子多載，且找不到預期的具名替代方法。 具名的替代成員會提供與運算子相同的功能存取，並且可供以不支援多載運算子 (Overloaded Operator) 的語言設計程式的開發人員使用。 |
|
型別實作等號比較運算子或不等比較運算子，但未實作相反的運算子。 |
|
可寫入的集合屬性允許使用者以不同的集合來取代該集合。 唯讀屬性會從取代過程中停止集合，但是仍然允許設定個別成員。 |
|
使用 .NET Framework 發行前版本建置的資源檔，可能無法讓 .NET Framework 的支援版本使用。 |
|
若要修正此規則的違規情形，請實作序列化建構函式。 針對密封類別，讓建構函式成為 private，否則為 protected。 |
|
公用或保護的型別包含使用 VarArgs 呼叫慣例之公用或保護的方法，而不是 params 關鍵字。 |
|
實值型別會覆寫 Object.Equals，但不會實作等號比較運算子。 |
|
STAThreadAttribute 表示應用程式的 COM 執行緒模型為單一執行緒 Apartment。 在使用 Windows Form 的任何應用程式之進入點上必須有此屬性。如果省略的話，Windows 元件就無法正常運作。 |
|
如果沒有先驗證運算元，以確定運算結果不會超過所包含之資料型別的可能值範圍，則不應執行算術運算。 |
|
呼叫字串參數名稱包含 "uri"、"URI"、"urn"、"URN"、"url" 或 "URL"， 而且此方法的宣告型別會包含具有 System.Uri 參數的對應方法多載。 |
|
可序列化之型別中所宣告之型別的執行個體 (Instance) 欄位是不可序列化的。 |
|
若要修正此規則的違規情形，請從對應的衍生型別方法或建構函式，呼叫基底型別 GetObjectData 方法或序列化建構函式。 |
|
若要讓 Common Language Runtime 辨認為可序列化，即使型別透過 ISerializable 介面的實作使用自訂序列化常式，型別仍必須以 SerializableAttribute 屬性標記。 |
|
處理序列化事件的方法沒有正確的簽章、傳回型別或可視性。 |
|
型別具有以 System.Runtime.Serialization.OptionalFieldAttribute 屬性標示的欄位，而且型別不提供還原序列化事件處理方法。 |
|
若要修正此規則的違規情形，請將 GetObjectData 方法設為可見和可覆寫的，並確定所有執行個體欄位都加入序列化處理序中，或已明確標記 NonSerializedAttribute 屬性。 |
|
傳遞至 System.String.Format 的格式引數不包含對應至每個物件引數的格式項目，反之亦然。 |
|
此運算式針對 Single.Nan 或 Double.Nan 測試值。 使用 Single.IsNan(Single) 或 Double.IsNan(Double) 即可測試值。 |
|
屬性的字串常值參數未針對 URL、GUID 或版本進行正確剖析。 |
變更記錄
日期 |
記錄 |
原因 |
|---|---|---|
|
2010 年 8 月 |
已加入 CA1801、CA1806 和 CA1816 警告的遺漏摘要。 |
客戶回函。 |