如何將方法標記爲過期或已棄用?

如何使用C#將方法標記爲過期或過期? 函數


#1樓

最簡單的方法是將ObsoleteAttribute做爲方法屬性添加。 確保包括適當的解釋: 工具

[Obsolete("Method1 is deprecated, please use Method2 instead.")]
public void Method1()
{ … }

若是從下面的代碼中調用該方法,您也可能致使編譯失敗,將方法的使用視爲錯誤而不是警告spa

[Obsolete("Method1 is deprecated, please use Method2 instead.", true)]

#2樓

使用關鍵字Obsolete向方法添加註釋。 消息參數是可選的,可是一個很好的主意,用於傳達爲何如今該項目已過期和/或使用什麼代替。
例: code

[System.Obsolete("use myMethodB instead")]
void myMethodA()

#3樓

用警告標記爲過期: 圖片

[Obsolete]
private static void SomeMethod()

使用時會收到警告: get

顯示過期的警告

藉助IntelliSense: 編譯器

IntelliSense已過期的警告

若是您想留言: string

[Obsolete("My message")]
private static void SomeMethod()

這是IntelliSense工具提示: io

IntelliSense顯示過期的消息

最後,若是您但願將用法標記爲錯誤: 編譯

[Obsolete("My message", true)]
private static void SomeMethod()

使用後,您會獲得:

方法使用狀況顯示爲錯誤

注意:使用該消息告訴人們應該使用什麼,而不是爲何它已過期。


#4樓

使用ObsoleteAttribute您能夠顯示不同意使用的方法。 過期的屬性具備三個構造函數:

  1. [Obsolete]:是無參數構造函數,而且是使用此屬性的默認值。
  2. [Obsolete(string message)]:以這種格式,您能夠得到有關不同意使用此方法的message
  3. [Obsolete(string message, bool error)]:此格式的消息很是明確,可是error表示在編譯時,編譯器必須顯示錯誤,致使編譯失敗或失敗。

在此處輸入圖片說明

相關文章
相關標籤/搜索