Gendarme.Rules.BadPractice.ObsoleteMessagesShouldNotBeEmptyRule(2.10)

ObsoleteMessagesShouldNotBeEmptyRule

Assembly: Gendarme.Rules.BadPractice
Version: 2.10

Description

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).

Examples

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 ();
    }
}