rspec/rules/S4016/csharp/rule.adoc

46 lines
954 B
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
If an ``++enum++`` member's name contains the word "reserved" it implies it is not currently used and will be change in the future. However changing an ``++enum++`` member is a breaking change and can create significant problems. There is no need to reserve an ``++enum++`` member since a new member can be added in the future, and such an addition will usually not be a breaking change.
This rule raises an issue when the name of an enumeration member contains "reserved".
=== Noncompliant code example
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,csharp]
2021-04-28 16:49:39 +02:00
----
using System;
namespace MyLibrary
{
public enum Color
{
None,
Red,
Orange,
Yellow,
ReservedColor // Noncompliant
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Remove or rename this enum member.
=== Highlighting
Enum member
endif::env-github,rspecator-view[]