Click here to Skip to main content
12,453,354 members (64,121 online)
Click here to Skip to main content
Add your own
alternative version

Tagged as

Stats

28.7K views
14 bookmarked
Posted

How can we mark a method as deprecated in c#?

, 14 Jul 2013 CPOL
Rate this:
Please Sign up or sign in to vote.
How can we mark a method as deprecated?

Many times you want to warn developers that some methods or classes should not be used as they are either replaced or going to be replaced with new versions. This is possible by using the “[Obsolete]” attribute.

In the below class we have a method called as “Method1”. Now let’s say you have created a better improvised version of “Method1” called as “NewMethod1”. You want to send an alert to all your developers who are consuming this class to use “NewMethod1” rather than using “Method1”.

So you can decorate “Method1” with the “[Obsolete]” attribute as shown in the below code.

public class Class1
{
    [Obsolete]
    public void Method1()
    {

    }

    public void NewMethod1()
    {
    }
}

Now if any programmer consumes the above class he will get a warning message as shown in the below figure.

In case you want to show some message to the developers you can pass the message in the “Obsolete” attribute as shown in the below code snippet.

[Obsolete("Please use NewMethod1")]
public void Method1()
{

}

If you want to be bit strict and do not developers to use that method, you can pass ‘true” to the “Obsolete” attribute as shown in the below code.

[Obsolete("Please use NewMethod1",true)]
public void Method1()
{

}

Now in case developers try to make a call to “Method1” they will get error and not just a simple warning.

Also have a look at the following practical demonstration on C# Obsolete video: -

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author


You may also be interested in...

Pro
Pro

Comments and Discussions

 
GeneralMy vote of 1 Pin
Member 852840918-Aug-13 6:09
memberMember 852840918-Aug-13 6:09 
GeneralMy vote of 1 on Your Vote of 1 Pin
Keith Barrow19-Aug-13 4:54
mentorKeith Barrow19-Aug-13 4:54 
"Not worth" what?

This blog entry is factually accurate, describes a useful bit of functionality and is well written. It certainly doesn't deserved a one vote in my opinion. Your reply does deserve one though, you manage to be critical whilst making no sense yourself.

GeneralRe: My vote of 1 on Your Vote of 1 Pin
Member 852840921-Aug-13 4:18
memberMember 852840921-Aug-13 4:18 
GeneralRe: My vote of 1 on Your Vote of 1 Pin
Keith Barrow21-Aug-13 4:21
mentorKeith Barrow21-Aug-13 4:21 
GeneralRe: My vote of 1 on Your Vote of 1 Pin
Shivprasad koirala21-Aug-13 5:57
mvpShivprasad koirala21-Aug-13 5:57 
GeneralRe: My vote of 1 on Your Vote of 1 Pin
Keith Barrow21-Aug-13 22:42
mentorKeith Barrow21-Aug-13 22:42 
GeneralRe: My vote of 1 on Your Vote of 1 Pin
Shivprasad koirala21-Aug-13 5:58
mvpShivprasad koirala21-Aug-13 5:58 
GeneralRe: My vote of 1 on Your Vote of 1 Pin
Shivprasad koirala21-Aug-13 5:59
mvpShivprasad koirala21-Aug-13 5:59 
GeneralRe: My vote of 1 on Your Vote of 1 Pin
Member 852840921-Aug-13 10:26
memberMember 852840921-Aug-13 10:26 
GeneralMy vote of 4 Pin
SriramNidamanuri15-Aug-13 19:49
memberSriramNidamanuri15-Aug-13 19:49 
GeneralMy vote of 5 Pin
Humayun Kabir Mamun14-Aug-13 23:10
memberHumayun Kabir Mamun14-Aug-13 23:10 
GeneralMy vote of 5 Pin
DrABELL10-Aug-13 15:37
professionalDrABELL10-Aug-13 15:37 
GeneralMy vote of 5 Pin
R.Hari Prasath1-Aug-13 23:46
memberR.Hari Prasath1-Aug-13 23:46 
GeneralMy vote of 5 Pin
Matej Vilim21-Jul-13 23:48
memberMatej Vilim21-Jul-13 23:48 
GeneralMy vote of 5 Pin
Cindy Meister17-Jul-13 3:39
memberCindy Meister17-Jul-13 3:39 
GeneralMy vote of 5 Pin
dxs75315-Jul-13 1:07
memberdxs75315-Jul-13 1:07 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.160826.1 | Last Updated 15 Jul 2013
Article Copyright 2013 by Shivprasad koirala
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid