-
Notifications
You must be signed in to change notification settings - Fork 4
Gendarme.Rules.BadPractice.ObsoleteMessagesShouldNotBeEmptyRule(git)
Sebastien Pouliot edited this page Mar 2, 2011
·
1 revision
Assembly: Gendarme.Rules.BadPractice
Version: git
This rule warns if any type (including classes, structs, enums, interfaces and delegates), field, property, events, method and constructor are decorated with an empty Obsolete attribute because the attribute is much more helpful if it includes advice on how to deal with the situation (e.g. the new recommended API to use).
Bad example:
[Obsolete]
public byte[] Key {
get {
return (byte[]) key.Clone ();
}
}
Good example:
[Obsolete ("Use the new GetKey() method since properties should not return arrays.")]
public byte[] Key {
get {
return (byte[]) key.Clone ();
}
}
You can browse the latest source code of this rule on github.com
Note that this page was autogenerated (3/17/2011 1:55:44 PM) based on the xmldoc
comments inside the rules source code and cannot be edited from this wiki.
Please report any documentation errors, typos or suggestions to the
Gendarme Mailing List. Thanks!