How to mark / warn that a method is obsolete

Question

How to mark / warn that a method is obsolete

Navigation

#1 by (3 votes)

3

I've noticed several times in Visual Studio about obsolete methods of some components / libraries:

Asforexampleleavingthemethodbelowobsolete:

///<summary>//////</summary>///<paramname="a"></param>
    /// <exception cref=""></exception>
    /// <returns></returns>
    public string MeuMetodo(string a)
    {
        return a;
    }

c#

asked by anonymous 22.02.2017 / 20:42

1 answer

Calculation of the Shannon entropy in a network traffic (saved in CAP file) using Python How can I maintain only specific DataFrame rows?

score 3 · Accepted Answer

Only use the Obsolete .

It is also possible to pass a custom message to the warning and as a second parameter a boolean that defines whether the use of this method will only generate a warning or an error .

Example

public static class Classe
{
    [Obsolete("Use o novo método")]
    public static void MeuMetodo(string a) { }

    [Obsolete("Use o novo método", true)]
    public static void OutroMetodo(string a) { }
}

I do not use

Classe.MeuMetodo("A");
// Gera um warning "Use o novo método"

Classe.OutroMetodo("B");
// Gera um erro e interrompe a compilação