Obsolete Attribute
This page was last reviewed on Jul 1, 2021.
Dot Net Perls
Obsolete. The C# Obsolete attribute generates a compile-time warning. When a method has the Obsolete attribute, the C# compiler issues a warning if it is called.
Obsolete benefits. This attribute helps keep programs correct. This makes it easier to transition from old methods. It can help improve overall code quality.
To begin, the Obsolete attribute is found in the System namespace. It is an attribute type, which means you can specify the type as Obsolete or ObsoleteAttribute.
Detail The suffix "Attribute" is automatically added at compile-time. This is a rare magical feature of the C# language.
Tip To specify an attribute, decorate a method with the declaration and surround the attribute with square brackets.
Info You can use Obsolete with zero, one, and two arguments. This example uses one argument. It generates a compile-time warning.
using System; class Program { static void Main() { MethodA(); } [Obsolete("Use MethodB instead")] static void MethodA() { } }
... warning CS0618: 'Program.MethodA()' is obsolete: 'Use MethodB instead'
Attribute info. Attributes are invoked the same way as constructors. The Obsolete attribute can have zero arguments. In this case, a generic compile-time warning is generated.
And The attribute can have one or two arguments. The compilation fails if you specify true as the second argument.
Summary. Obsolete is useful for versioning. If you have developed a new control flow and a certain method is no longer wanted, you can decorate it with the Obsolete attribute.
Final notes. Once you have added Obsolete, you can correct warnings or errors as you go along. In larger projects this can help coordinate the methods different programmers employ.
Dot Net Perls is a collection of tested code examples. Pages are continually updated to stay current, with code correctness a top priority.
Sam Allen is passionate about computer languages. In the past, his work has been recommended by Apple and Microsoft and he has studied computers at a selective university in the United States.
This page was last updated on Jul 1, 2021 (rewrite).
© 2007-2024 Sam Allen.